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.

Sign up for GitHub

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 CONTRIBUTING.md #166

Merged
merged 3 commits into from
May 25, 2023
Merged

Update CONTRIBUTING.md #166

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ae0c6c9
Update CONTRIBUTING.md
thomasturrell May 25, 2023
36a477c
Apply suggestions from code review
thomasturrell May 25, 2023
bcd64c1
Update CONTRIBUTING.md
thomasturrell May 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 14 additions & 5 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,30 @@
## Releasing a new version
## Publishing a new version

### Creating a release branch
```bash
git checkout -b release-x.x.x
git push --set-upstream origin release-x.x.x
```

Note: x.x.x should be the next version not the current version.

### Setting the version

```bash
cd projects/ngx-unsplash
npm version x
```

Note: x should be replaced with either major, minor or patch.
Note: x should be replaced with either major, minor or patch. The `npm version` command will create push a tag for the version.
thomasturrell marked this conversation as resolved.
Show resolved Hide resolved

### Creating a GitHub Release

Next, create a [GitHub release](https://github.com/BerryCloud/ngx-unsplash/releases) for the newly created version tag.

Once the GitHub release has been created GitHub actions will build publish the new version.
thomasturrell marked this conversation as resolved.
Show resolved Hide resolved

The tag be will automatically pushed.
### Merging the release branch into main

Github actions will build and deploy the tag.
A pull request should then be created for the release branch to merge the changes back into main.

A pull request should then be created for the release branch.
Note: Inorder to see the tag on the main branch, the changes should be merged back into main rather than squashed.