Skip to content

Conversation

ndr-brt
Copy link

@ndr-brt ndr-brt commented Jun 13, 2025

What

Adaptation of pulsar-edit/pulsar-edit.github.io#297
to this repository

Notes

Improve and update "publishing" section, specifically it adds some docs for the login part

Copy link
Collaborator

@savetheclocktower savetheclocktower left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I'm happy to take the reworking of the “things to double-check before publishing” list, but most of the rest is a simple rephrasing rather than adding new information or removing inaccurate information. I may apply the one change on its own and respectfully decline to change the rest of it.

@ndr-brt
Copy link
Author

ndr-brt commented Sep 2, 2025

Yeah, I'm happy to take the reworking of the “things to double-check before publishing” list, but most of the rest is a simple rephrasing rather than adding new information or removing inaccurate information. I may apply the one change on its own and respectfully decline to change the rest of it.

I'll be ok with any decision you'll take.
I did this "rephrasing" just because I had issues in publishing the package because the documentation was messed up, with outdated and missing information.

<!-- TODO: Rewrite this Section once Authentication Information is Public -->
`pulsar -p login` will let you create and set an API token in your keychain to permit interacting with GitHub API

If this is the first package you are publishing, the `pulsar -p publish` command may prompt you for your GitHub username and password. If you have two-factor authentication enabled, use a [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) in lieu of a password. This is required to publish and you only need to enter this information the first time you publish. The credentials are stored securely in your [keychain](<https://en.wikipedia.org/wiki/Keychain_(software)>) once you login.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I understand this change better after your comment on the other PR. I agree that this information is wrong, but I'd like to make sure we replace it with correct information. Did you hit this code path when you tried to publish?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added the keychain info at line 34, and discarded all the rest. let me know if that works out

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants