NoRedInk/noredink-ui
1
1
Fork 0
mirror of https://github.com/NoRedInk/noredink-ui.git synced 2025-01-06 22:49:38 +03:00
Code Issues Packages Projects Releases Wiki Activity

Including additional documentation on publish flow around git tag errors introduced by branch protection breaking the default flow proposed by elm publish

Browse Source
This commit is contained in:
Mike Steder 2023-03-15 18:01:09 -05:00
parent fcf4a5776f
commit 3407e2fe29
No known key found for this signature in database
GPG Key ID: 79AD87DD1A06E0C6
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -142,6 +142,13 @@ Any NoRedInk engineer can deploy a new version of `noredink-ui`. Generally, we p
- `git pull`
- Run `elm publish` and follow its prompts
- Note: when you're asked to create a version tag, **please be sure to include a meaningful message**! Include details in the message that describe why this noredink-ui version exists at ll.
- Create an annotated tag like this:
```
git tag -a 22.x.y -m "Description of this release version: i.e.: 'high-contrast mode highlight style change'"
```
- Because of branch protection you will not be able to push a tag like: `git push origin master 22.x.y` (The previous command requires permissions to push directly to master even if you have no changes).
- Instead, please push your new `22.x.y` tag with the following: `git push origin 22.x.y`
Once you've published, you should see the latest version at <https://package.elm-lang.org/packages/NoRedInk/noredink-ui/>. It can take a few minutes to show up.