Skip to content

Commit

Permalink
override ip
Browse files Browse the repository at this point in the history
  • Loading branch information
Aaron Shiel committed Nov 7, 2024
1 parent 0d891fd commit 3990227
Show file tree
Hide file tree
Showing 3 changed files with 252 additions and 83 deletions.
25 changes: 6 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Development

Required Software
=================
- node 13.2+
- node 16.14+
- npm
- make

Expand All @@ -42,21 +42,8 @@ To fix formatting issues:
make format
```

Releases
--------

Currently, this image is semantically versioned. When making changes that you want to test in another project, create a branch and PR and then you can release a test tag one of two ways:

To build/push a pre-release semver tag of `mentor-graphql` for the current commit in your branch

- create a [github release](https://github.com/ICTLearningSciences/mentor-graphql/releases/new) **from your development branch** with tag format `/^\d+\.\d+\.\d+(-[a-z\d\-.]+)?$/` (e.g. `1.0.0-alpha.1`)
- find the `docker_tag_release` workflow for your git tag in [github actions](https://github.com/ICTLearningSciences/mentor-graphql/actions?query=workflow%3A%22build%2Fpub+candidate%22)
- this will create a tag like `mentorpal/mentor-graphql:1.0.0-alpha.1`



Once your changes are approved and merged to main, you should create a release tag in semver format as follows:

- create a [github release](https://github.com/ICTLearningSciences/mentor-graphql/releases/new) **from main** with tag format `/^\d+\.\d+\.\d$/` (e.g. `1.0.0`)
- find the `docker_tag_release` workflow for your git tag in [github actions](https://github.com/ICTLearningSciences/mentor-graphql/actions?query=workflow%3A%22build%2Fpub+release%22)
- this will create a tag like `mentorpal/mentor-graphql:1.0.0`
Technical Debt
-------------
- mongoose
- delete mongo-cursor-pagination bson override once mongoose 8 upgrade is complete
- track ip package fix here https://github.com/indutny/node-ip/issues/150, delete override once fixed
Loading

0 comments on commit 3990227

Please sign in to comment.