Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update / modernize publishing docs. #173

Merged
merged 1 commit into from
Feb 29, 2024
Merged

Conversation

theengineear
Copy link
Collaborator

No description provided.

@theengineear theengineear force-pushed the update-publishing-docs branch from a8017d3 to d739126 Compare February 29, 2024 17:57
5. In the GitHub UI, find [the tag you just pushed](https://github.com/Netflix/x-element/tags) and find the "Create release" option.
6. Add any additional release information (including to check the box if it's a "pre-release", it probably is!).
1. Ensure your local `main` branch is checked-out and current — `git checkout main && git pull origin main`.
2. Run `npm version` to view the current version. Then…
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Surprise! The functionality of npm version has changed in the latest version. Sort of surprising, but not a huge deal. It used to prompt you for a version after running, now, you have to pass the versioning information up-front. Sorta sensible, but caught me off guard earlier.

2. Run `npm version` to view the current version. Then…
* **For Normal Releases** use a keyword like `major`, `minor`, or `patch` (e.g., `npm version patch`).
* **For Release Candidates** manually declare the next version (e.g., `npm version 1.0.0-rc.57`).
3. Push the resulting commit and tags — `git push origin main --follow-tags`.
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

TIL — --follow-tags to do all this in a single command. Neat.

@theengineear theengineear merged commit eca7c06 into main Feb 29, 2024
1 check passed
@theengineear theengineear deleted the update-publishing-docs branch February 29, 2024 18:04
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.

1 participant