Skip to content

Commit

Permalink
Updates the readme to be more clearly spelled out for first time and …
Browse files Browse the repository at this point in the history
…repeat updates
  • Loading branch information
dakota002 authored and lpsinger committed Oct 18, 2023
1 parent 56850e8 commit 06e8544
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,24 @@ Please add your schema to this repository under <code>gcn/notices/<i>mission</i>
git clone [email protected]:nasa-gcn/gcn-schema.git
cd gcn-schema

2. Tag a new version by running the following command: `npm version [ major | minor | patch ]`. Choose `major`, `minor`, or `patch` depending on the kind of update according to [Semantic Versioning](https://semver.org) rules.
2. Install necessary npm packages

npm install

3. Tag a new version by running the following command: `npm version [ major | minor | patch ]`. Choose `major`, `minor`, or `patch` depending on the kind of update according to [Semantic Versioning](https://semver.org) rules.

This command will handle the intermediate steps of updating and committing the path changes in each file as defined in the `version` and `postversion` npm scripts

3. Review the changes with `git log -p` to make sure that each file is appropriately updated.
4. Review the changes with `git log -p` to make sure that each file is appropriately updated.

4. Finally, push both the commit and the tag:
5. Finally, push both the commit and the tag:

git push && git push origin <tag name>

This will make release available for use.
This will make the release available for use. For subsequent releases:

1. Pull the latest state of the main branch

git pull

2. Follow the above steps from Step 3 on.

0 comments on commit 06e8544

Please sign in to comment.