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

README and Tagged Release Template Issue changes #1191

Merged
merged 1 commit into from
Aug 8, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
23 changes: 19 additions & 4 deletions .github/ISSUE_TEMPLATE/tagged-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ assignees: ''

- [ ] Update the version in *package.json*
- [ ] `npm i` to regenerate *package-lock.json*
- [ ] Create a feature branch in git for the version (suggest `patch-{verson}`)
- [ ] Create a feature branch in git for the version (suggest `patch-{verson}`)
- [ ] `npm publish` to publish the version to [npm registry](https://npmjs.com).
- [ ] Product owner assigned Release notes
- [ ] Updates `NewsItem.js` component, creates commit on feature branch.
- [ ] Sinopia [Wiki](https://github.com/LD4P/sinopia/wiki/Latest-Release,-What's-Next)
- [ ] Sinopia [Wiki](https://github.com/LD4P/sinopia/wiki/Latest-Release,-What's-Next)
- [ ] Feature branch merged and circle-ci has successfully pushed new builds for
the `latest`, `stage`, and `prod` to docker hub.
- [ ] Git annotated tag and push to Github
Expand All @@ -22,16 +22,31 @@ assignees: ''
[releases](https://github.com/LD4P/sinopia_editor/releases)
- [ ] Dockerhub Images Management
- [ ] Pull latest **stage** and **prod** images
- [ ] `docker pull ld4p/sinopia_editor:stage`
- [ ] `docker pull ld4p/sinopia_editor:stage`
- [ ] `docker pull ld4p/sinopia_editor:prod`
- [ ] Tag **stage** and **prod** images with version
- [ ] `docker tag ld4p/sinopia_editor:stage ld4p/sinopia_editor:{version}-stage`
- [ ] `docker tag ld4p/sinopia_editor:prod ld4p/sinopia_editor:{version}-prod`
- [ ] Push the tagged versions to Dockerhub
- [ ] `docker push ld4p/sinopia_editor:{version}-stage`
- [ ] `docker push ld4p/sinopia_editor:{version}-prod`
- [ ] AWS Images for supporting projects - the Sinopia stack requires
a number of other projects to run successfully both locally and on AWS. If any of
these projects changed between tagged releases, you will need to update and tag the
latest image on Dockerhub along with corresponding update to Terraform with the tagged
release.
- [ ] Sinopia ACL https://github.com/LD4P/sinopia_acl
- [ ] Download the latest image `docker pull ld4p/sinopia_acl:latest`
- [ ] Create a tagged version `docker tag ld4p/sinopia_acl:latest ld4p/sinopia_acl:{version}`
- [ ] Push new tagged version `docker push ld4p/sinopia_acl:{version}`
- [ ] Update Terraform with the new tagged version and create PR
- [ ] Sinopia Indexing Pipeline https://github.com/LD4P/sinopia_indexing_pipeline
- [ ] Download the latest image `docker pull ld4p/sinopia_indexing_pipeline:latest`
- [ ] Create a tagged version `docker tag ld4p/sinopia_indexing_pipeline:latest ld4p/sinopia_indexing_pipeline:{version}`
- [ ] Push new tagged version `docker push ld4p/sinopia_indexing_pipeline:{version}`
- [ ] Update Terraform with the new tagged version and create PR
- [ ] Once tagged release is live on https://development.sinopia.io, this ticket will be assigned to the product owner who will approve the tagged release for deployment on
- [ ] Staging at https://stage.sinopia.io/
- [ ] Create a new terraform PR for staging
- [ ] Create a new terraform PR for staging
- [ ] Production at https://sinopia.io
- [ ] Create a new terraform PR for production
49 changes: 32 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -230,29 +230,44 @@ The steps to create a tagged release of the Sinopia's Linked Data Editor are as
1. Create a feature branch in git for the version (suggest `patch-{verson}`)
1. `npm publish` to publish the version to [npm registry](https://npmjs.com).
1. Product owner assigned Release notes
- Updates `NewsItem.js` component, creates commit on feature branch.
- Sinopia [Wiki](https://github.com/LD4P/sinopia/wiki/Latest-Release,-What's-Next)
- Updates `NewsItem.js` component, creates commit on feature branch.
- Sinopia [Wiki](https://github.com/LD4P/sinopia/wiki/Latest-Release,-What's-Next)
1. Feature branch merged and circle-ci has successfully pushed new builds for
the `latest`, `stage`, and `prod` to docker hub.
1. Git annotated tag and push to Github
- `git tag -a v{version} -m "{your message}"` to create an annotated tag
- `git push origin v{version}` to push up to the project's
- `git tag -a v{version} -m "{your message}"` to create an annotated tag
- `git push origin v{version}` to push up to the project's
[releases](https://github.com/LD4P/sinopia_editor/releases)
1. Dockerhub Images Management
1. Pull latest **stage** and **prod** images
- `docker pull ld4p/sinopia_editor:stage`
- `docker pull ld4p/sinopia_editor:prod`
1. Tag **stage** and **prod** images with version
- `docker tag ld4p/sinopia_editor:stage ld4p/sinopia_editor:{version}-stage`
- `docker tag ld4p/sinopia_editor:prod ld4p/sinopia_editor:{version}-prod`
1. Push the tagged versions to Dockerhub
- `docker push ld4p/sinopia_editor:{version}-stage`
- `docker push ld4p/sinopia_editor:{version}-prod`
1. Pull latest **stage** and **prod** images
- `docker pull ld4p/sinopia_editor:stage`
- `docker pull ld4p/sinopia_editor:prod`
1. Tag **stage** and **prod** images with version
- `docker tag ld4p/sinopia_editor:stage ld4p/sinopia_editor:{version}-stage`
- `docker tag ld4p/sinopia_editor:prod ld4p/sinopia_editor:{version}-prod`
1. Push the tagged versions to Dockerhub
- `docker push ld4p/sinopia_editor:{version}-stage`
- `docker push ld4p/sinopia_editor:{version}-prod`
1. AWS Images for supporting projects - the Sinopia stack requires
a number of other projects to run successfully both locally and on AWS. If any of
these projects changed between tagged releases, you will need to update and tag the
latest image on Dockerhub along with corresponding update to Terraform with the tagged
release.
- Sinopia ACL https://github.com/LD4P/sinopia_acl
- Download the latest image `docker pull ld4p/sinopia_acl:latest`
- Create a tagged version `docker tag ld4p/sinopia_acl:latest ld4p/sinopia_acl:{version}`
- Push new tagged version `docker push ld4p/sinopia_acl:{version}`
- Update Terraform with the new tagged version and create PR
- Sinopia Indexing Pipeline https://github.com/LD4P/sinopia_indexing_pipeline
- Download the latest image `docker pull ld4p/sinopia_indexing_pipeline:latest`
- Create a tagged version `docker tag ld4p/sinopia_indexing_pipeline:latest ld4p/sinopia_indexing_pipeline:{version}`
- Push new tagged version `docker push ld4p/sinopia_indexing_pipeline:{version}`
- Update Terraform with the new tagged version and create PR
1. Once tagged release is live on https://development.sinopia.io, this ticket will be assigned to the product owner who will approve the tagged release for deployment on
1. Staging at https://stage.sinopia.io/
- Create a new terraform PR for staging
1. Production at https://sinopia.io
- Create a new terraform PR for production
1. Staging at https://stage.sinopia.io/
- Create a new terraform PR for staging
1. Production at https://sinopia.io
- Create a new terraform PR for production

# LD4P's fork of the BIBFRAME Editor
The Sinopia Editor is forked from [https://github.com/lcnetdev/bfe][BFE_GIT].
Expand Down