How do I publish a package to Pulsar

[manngo]

I have an existing package written for Atom. Of course, I want to complete my migration, but I can’t find any documentation.

In the past, I ran something like:

apm publish minor

Of course, there isn’t any apm now, especially on my new Mac, which never had Atom installed. A passing reference in #63 suggests it is:

pulsar -p

but I can’t find a pulsar command either.

What is the missing step?

[Daeraxa]

The documentation is on the website - https://pulsar-edit.dev/docs/launch-manual/sections/core-hacking/#publishing

However, as of right now the authentication hasn't been made live to allow publishing just yet (coming very soon though).

The missing pulsar command will be because it is missing from your PATH. What OS and release type are you using?
EDIT - Seems you are on mac after re-reading. The missing PATH install is a known issue however a user did manage to solve this themselves - see this thread on Discord. Text below:

With $ which atom, I found that the alias was in /usr/local/bin/atom, so I changed /Applications/Atom.app/Contents/Resources/app/atom.sh to /Applications/Pulsar.app/ Contents/Resources/app/pulsar.sh copy and replaced Atom with Pulsar.Perhaps there is a smarter method, but thanks for the your guidance.

[anonCoffee]

@confused-Techie Discord is also just another proprietary headache and nothing else.

[Daeraxa]

@confused-Techie Discord is also just another proprietary headache and nothing else.

Noted and ignored

[anonCoffee]

Ignored for bad. Do whatever.

[Daeraxa]

Just to add to this, we are looking at making a Matrix space with a discord bridge for those who would rather not use it.

[confused-Techie]

Yes, and also if you'd like all communication can happen on GitHub, which I know you are also not a fan of. But then you could communicate strictly on Mastodon. We try to have options out there for everyone

[confused-Techie]

I'd like to add @manngo if your package was previously published to Atom, it's very likely that it's already on the Pulsar Package Repository.

Is it possible this is your package?

https://web.pulsar-edit.dev/packages/web-developer-tools

[confused-Techie]

Thanks, I saw that. I was wondering about publishing my updates (I noticed a new bug, caused, I think, by an change in file handling).

Unfortunately like @Daeraxa mentioned currently Authentication is disabled on the backend, meaning no one can login yet to update packages, or publish new ones.

Although in the very near future we are planning to enable authentication and at that time you should be able to publish an update with no issues after creating a Pulsar User Account.

If everything goes to plan to the backend will automatically recognize you as the owner of the package, as long as you still have write access to the repo.

[manngo]

Meanwhile, if I publish to Atom with atm would it find its way to Pulsar?

[mauricioszabo]

APM and all Atom servers are offline now, so... unfortunately, no.

Even if they where online, Atom was plagued with SPAM packages in the last few months, so we could not synchronize anymore...

[manngo]

Thanks. I’ll wait until then.

Thanks for all of your hard work and help.

[confused-Techie]

Thanks. I’ll wait until then.

Thanks for all of your hard work and help.

Actually Authentication is now on! Take a look at the release, which has some links to docs to help you get started and make an account

[manngo]

OK, I am still trying to get this to work for me. Here is what I have attempted:

• First, I have logged in to https://api.pulsar-edit.dev/api/login

• Second, I went into my project directory and attempted to publish it according to https://pulsar-edit.dev/docs/launch-manual/sections/core-hacking/#using-ppm-pulsar-package-manager:

  cd github/atom-web-tools
  /Applications/Pulsar.app/Contents/Resources/pulsar.sh -p publish minor

I am getting the error message:

The application //Applications cannot be opened for an unexpected reason, error=Error Domain=NSOSStatusErrorDomain Code=-10827 "kLSNoExecutableErr: The executable is missing" UserInfo={_LSLine=4101, _LSFunction=_LSOpenStuffCallLocal}

So obviously I’m still missing something.

I am guessing that the other requirements are still OK, as the package has been published and updated a number of times.

[confused-Techie]

Hopefully someone from @pulsar-edit/core can chime in on the error you are seeing.

As for the backend and publishing looks like you're on the right track, I'd only make sure that you use your new API token to login to PPM.

pulsar -p --login PULSAR_API_TOKEN (I think is the command) Then you should be able to publish with that command.

I'd also just like to advise making sure you are on the most up to date Alpha build, as we have been sorting a lot of PPM issues recently so that will give you the best chances to publish successfully

[manngo]

Thanks for the login step: I didn’t know how to use it.

However, I’m still getting the same error message.

I’ll check on the Pulsar version.

[Daeraxa]

cd github/atom-web-tools
/Applications/Pulsar.app/Contents/Resources/pulsar.sh -p publish minor

You aren't trying to execute pulsar.sh are you? That isn't the pulsar executable, that is a supporting shell script.

[manngo]

No, that’s what I used at first, but I have discovered that it’s /Applications/Pulsar.app/Contents/MacOS/Pulsar . I don’t know why I didn’t see that executable before.

[manngo]

I am getting one step closer, I think.

The steps now are:

$	cd github/atom-web-tools
$	/Applications/Pulsar.app/Contents/MacOS/Pulsar -p login
Token>	…
$	/Applications/Pulsar.app/Contents/MacOS/Pulsar -p publish minor

However, although the login step above says that the token is saved to the Keychain, the publish step still wants a username and password, and then tells me that password authentication was removed on August 13, 2021.

So I’m getting closer. I think.

[confused-Techie]

Okay so that's good.

Essentially what you are seeing here is part of a bigger discussion we are having, but I'll try to give you the TLDR.

Essentially, historically your API Token for Atom also allowed access to your GitHub account, so APM would access your GitHub account, tag the release and commit as needed for it's purposes, then tell the Atom API to publish the new package, then it would publish a new version.

But now, since we aren't GitHub that's changed. Essentially your Pulsar API Token is just that, a token to access the Pulsar API. PPM as it's mostly still APM tries to tag and publish to your GitHub account. So --login provides PPM with your Pulsar API Token, but PPM still needs your GitHub Username and Password. (Which GitHub doesn't support just logging in with a password through the CLI so you need to make a PAT token, and login here with your GitHub Username and PAT token).

So now PPM has your Pulsar API Token, and the credentials to access your GitHub account.

Once it has this it will now be able to Tag and commit to your GitHub account like it tries to, and will be able to publish the package to the new backend.

So with that you will be golden!

But fair warning, remember how I said APM tries to publish a package, then publish a new version? It will still do this but the backend now will automatically publish the version, so PPM will fail there. So will still return an error.

What this means in all reality, what success will look like for you right now is about this:

$ ~/pulsar/pulsar -p publish -t v0.2.3
Registering atom-developer-tools ✓
Preparing and tagging a new version ✓
Pushing v0.2.3 tag ✓
Publishing [email protected] ✗
Creating new version failed: Application Error

Obviously slightly different, but you get the drift, if it says publishing and returns an error go ahead and check what the latest version the backend has here.

[manngo]

Here are my revised steps:

#	Package Directory
	cd github/package-diretory

#	Log in to Pulsar
	/Applications/Pulsar.app/Contents/MacOS/Pulsar -p login
	Token>	…

#	Git Hub Personal Access Token
	See https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token
	
#	Publish
	/Applications/Pulsar.app/Contents/MacOS/Pulsar -p publish -t x.x.x
	User:		[user]
	Password:	[Access Token]

It appears to have worked, but I can’t update the package on Pulsar. When I try, I get the following error:

Updating to “[email protected]” failed.Hide output…

npm ERR! code E404
npm ERR! 404 Not Found - GET https://api.pulsar-edit.dev/api/packages/web-developer-tools/versions/0.4.4/undefined
npm ERR! 404
npm ERR! 404 'https://api.pulsar-edit.dev/api/packages/web-developer-tools/versions/0.4.4/tarball' is not in the npm registry.
npm ERR! 404 Your package name is not valid, because
npm ERR! 404 1. name can only contain URL-friendly characters
npm ERR! 404
npm ERR! 404 Note that you can also install from a
npm ERR! 404 tarball, folder, http url, or git url.

npm ERR! A complete log of this run can be found in:
npm ERR! /Users/mark/.pulsar/.apm/_logs/2022-12-28T03_54_32_795Z-debug.log

I don’t know whether that’s in the right direction … ?

[confused-Techie]

I'll be honest, I'm rather confused at these logs. The error you are getting doesn't seem to exist within PPM, the Backend, or within Pulsar.

Looks like it's attempting to install this package from NPM?

Anyone from @pulsar-edit/core have any ideas?

[DeeDeeG]

That error message comes out of the underlying npm package used in ppm, apparently.

https://github.com/npm/cli/blob/v6.14.18/lib/utils/error-message.js#L196-L225

It's for when the package you are publishing is not found at the registry you're trying to publish to.

[DeeDeeG]

404 Not Found - GET https://api.pulsar-edit.dev/api/packages/web-developer-tools/versions/0.4.4/undefined

That undefined at the end of that URL looks at least mildly suspicious. Perhaps we have some sort of error in ppm or the backend that's not forming that URL quite correctly? Or maybe some garbled data was fed through ppm or the backend to cause that undefined to come out the other end?

(I do hope to take a deep dive through the publishing process myself soon, and debug/troubleshoot some of these things, but no promises as to when I will next have the time to do so.)

---

[EDIT: Okay, so the tarball URL for this 0.4.4 package version (URL ending in /tarball) redirects to the same URL but ending in /undefined in place of /tarball, for some reason.

Maybe the tarball was expected by our backend, but was never uploaded (or the upload didn't finish...)? I admit this is just a guess as to why there is the redirect to /undefined. Something is wrong with what we have on our end for this package version, but it's unclear to me whether or not it originated/transmitted wrong from ppm.]

---

EDIT again: I notice this package's newer versions' API JSON responses don't have a tarball_url field, which should be pointing to GitHub.com. They only have dist.tarball, but older versions had both tarball_url and dist.tarball.

---

EDIT to add: https://web.pulsar-edit.dev/packages/web-developer-tools gives me a "This Page enccounted an Error! Sorry!" error page, and strangely enough, my browser dev tools show a 505 error.

Tangent/Off-topic: About the 505 error status code (click to expand):

"505 HTTP Version Not Supported

The HyperText Transfer Protocol (HTTP) 505 HTTP Version Not Supported response status code indicates that the HTTP version used in the request is not supported by the server. "

https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/505

Tangent: why a 505 error code? (click to expand):

(I am assuming it's just throwing a too-specific "505" error, but that my HTTP version isn't the real problem? Should be a generic 500 internal server error, maybe? But if part of the code hard-codes 505 by mistake, maybe that's a good thing to do a code search for? Where in the code does it throw a 505 error? EDIT: Yeah, looks like it's used by the frontend repo for any non-404 error status: https://github.com/pulsar-edit/package-frontend/blob/66a4742a3b38176cb74bce53cc7689fee42b5143/src/utils.js#L18-L30)

... Whereas for example the github package page loads fine for me: https://web.pulsar-edit.dev/packages/github

[manngo]

I might add that updating path-copy from 0.14.0 to 0.17.0 was successful. Thing might suggest that updating works, but my on publishing didn’t go through.

This is both on my current M1 Mac and and an older Intel iMac.

[cschindl]

Apparently the console command does not work under windows. When I execute it with pulsar -p help or pulsar -p login nothing happens afterwards.

I am therefore unfortunately not able to execute the login or publish command.

So I tried to do it with apm (Pulsar Package Manager) like I did with atom. Here I could add the token and also publish.

The repository was updated on github and a new tag was added. Unfortunately there was no new release and nothing changed on https://web.pulsar-edit.dev/packages/ftp-remote-edit. I have therefore removed the commits and the tag again.

What do I have to do if I want to update the package?

[topa-LE]

Would be really nice if you could install the update without errors.

[confused-Techie]

Did you actually use apm or ppm?
If it was apm that still would point to Atoms package registry, which no longer exists. So it would've only published the GitHub tag.

If it was done with ppm that likely worked, but there is currently this bug which could result in the version not being shown directly within settings or the website, but still installable as the latest version.

For example, I think this bug is what you saw with ftp-remote-edit. While the website still shows the current latest version as 0.18.2 when going to install the latest package version I get 0.20.0. So it looks like it was published to the server

[cschindl]

I used the Pulsar Package Manager. The executable apm.cmd is located in the folder C:\Program Files\Pulsar\resources\app\ppm\bin on Windows. I was therefore a bit confused by the name of the executable. However, running the apm.cmd clearly opens the Pulsar Package Manager.

And you are right. The registry contained the new version v0.20.0, so the update worked. I was just surprised that it was not displayed on the website in the new version.

After I added the v0.20.0 tag, the package could also be updated via Pulsar without any problems.

Thanks for the quick help.

P.S. It would be great if the documentation for publishing a package could be updated. The information at: https://pulsar-edit.dev/docs/launch-manual/sections/core-hacking/#publish-your-package unfortunately contains a lot of misinformation and also the previous login is not described there.

[confused-Techie]

@cschindl Okay I see what you mean now. But you are right about the docs needing an update. There is some work to do a large refactor on those as we want to move away from the Atom style Launch Manual anyway.

But also the bug I mentioned earlier I was able to fix today and now if you'd like publishing another version will get the website updated as well. So those should no longer be an issue. But I'm glad you got back to me and let me know what's going on, thanks a ton!

[manngo]

OK, things have moved on since I first ask this question.

I would now like to try updating the package again. Is this the correct process?

cd /path/to/package
/Applications/Pulsar.app/Contents/Resources/pulsar.sh -p publish patch # | major | minor

If so, I’m getting a number of different errors:

remote: Invalid username or password.
remote: Support for password authentication was removed on August 13, 2021
fatal: Authentication failed for 'https://github.com/manngo/atom-web-tools/'

I have already applied the token.

BTW thanks to @confused-Techie for looking at my other issue pulsar-edit/package-backend#125.

[manngo]

Sorry for the time gap.

I have tried again, and I’m getting the same issues. I removed old tags, since they were getting out of control, and tried to republish. I still get:

Creating new version failed: Application Error

Using curl -L -H "Accept: application/vnd.github+json" -H "Authorization: Bearer …" -H "X-GitHub-Api-Version: 2022-11-28" https://api.github.com/repos/manngo/atom-web-tools/collaborators I get:

https://api.github.com/repos/manngo/atom-web-tools/collaborators
{
	"message": "Requires authentication",
	"documentation_url": "https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators"
}

Again I can’t use ?page=1 on the end.

I have already gone through the /Applications/Pulsar.app/Contents/MacOS/Pulsar -p login process.

[confused-Techie]

You're okay @manngo. So yeah if that API call to GitHub is still returning an error, no matter what you do to Pulsar or PPM, publishing will fail. The backend relies on the results of this API call to publish a package, or really it relies on this API call to ensure you own the package, and should be able to publish it.

I'm really not quite sure what's causing this API call to fail, but it'd either be an issue with your token, or an issue with the repo, or an issue with GitHub itself.

I'd recommend seeing if you can create a brand new API token from the GitHub UI itself, and us that token for this API call. If it succeeds it can at least tell us that your Pulsar API token doesn't have the permissions needed. And once we know what permissions work, we can determine what's different between the two.

[cschindl]

I tried to update my package today. Unfortunately, I received the following error message:

PS C:\Users\Carsten\.pulsar\packages\ftp-remote-edit> ppm publish minor
Preparing and tagging a new version done
Pushing v0.21.0 tag done
Publishing [email protected] failed
Internal Server Error

The new tag has been set and also correctly pushed to the master on github. What do I have to do to successfully update the package?

[confused-Techie]

@cschindl I took a quick look at this, and while everything on PPM is succeeding, I was able to find an issue on the backend when attempting to publish the package ftp-remote-edit.

The backend returned the following error messages:

[WARNING]:: auth.verifyAuth() API Call returned: 401
[TRACE]:: auth.verifyAuth() API Call Returning Bad Auth

While the backend should've reported this too you, it looks like this PR which I merged just the other day encountered an error trying to ensure to scrub any sensitive details from the actual error message that you ended up receiving such a generic error message.

---

To solve this, I'd recommend checking the following:

• That you have provided PPM with your Pulsar Package Registry API Token
• That you have at least write permissions on the remote repository you are trying to publish.

If you feel like the authentication failure is still an error of the backend, if you could provide the actual repository you are trying to publish it'd be appreciated. Thanks for reporting this!

[DeeDeeG]

It seems possible the token was set to expire after some time, and has expired since the last attempt to publish a package? Worth checking whether the token is now expired.