Skip to content

Commit 191f597

Browse files
committed
Fix #8 Immutable Releases upd readme, add contributing
1 parent c7ed3ba commit 191f597

File tree

2 files changed

+40
-1
lines changed

2 files changed

+40
-1
lines changed

.github/CONTRIBUTING.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
[ < Back](../README.md)
2+
3+
# HowTo Contribute
4+
5+
Please create an [issue](https://github.com/boly38/action-mongo-tools/issues) describing your goal / question / bug description...
6+
7+
If you're interested in an existing issue, please contribute by up-voting for it by adding a :+1:.
8+
9+
If you want to push some code :
10+
- fork and prepare a feature-git-branch, then create a [pull request](https://github.com/boly38/action-mongo-tools/pulls) that link your issue.
11+
- execute test
12+
13+
You could also be critic with existing ticket/PR : all constructive feedbacks are welcome.
14+
15+
## test
16+
* cf. [TESTING.md](../TESTING.md)
17+
18+
19+
# Maintainer HowTos
20+
21+
## HowTo create a fresh version
22+
- install github client
23+
- create automatically a draft release version using [gh client](https://cli.github.com/)
24+
25+
Example to create v1.0.3
26+
```bash
27+
gh release create v1.0.3 --draft --generate-notes
28+
```
29+
30+
this will make a new draft release. Verify it in [releases list](https://github.com/boly38/action-mongo-tools/releases)
31+
32+
- ⚠️ the repository apply immutable releases since #8, so you can't modify a release once published
33+
- publish the release when ready

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,5 +31,11 @@ env:
3131
MONGOTOOLS_KEEP_MAN: true
3232
```
3333
34+
# Immutable releases
35+
36+
For security reason, since #8, this repository rely on [immutable releases](https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/immutable-releases).
37+
Instead of using `@stable` as tag, you could rely on fixed immutable release (ex. `@v1.0.4`).
38+
3439
# contributing
35-
PRs extending the functionality are welcome and will be reviewed.
40+
- PRs extending the functionality are welcome and will be reviewed.
41+
- more details on [CONTRIBUTING](./.github/CONTRIBUTING.md) and [TESTING](./TESTING.md)

0 commit comments

Comments
 (0)