-
Notifications
You must be signed in to change notification settings - Fork 42
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
Create first blog post on setup #89
Conversation
Codecov Report
@@ Coverage Diff @@
## master #89 +/- ##
=======================================
Coverage 64.12% 64.12%
=======================================
Files 36 36
Lines 7039 7039
=======================================
Hits 4514 4514
Misses 2525 2525 Continue to review full report at Codecov.
|
docs/blog/setup.md
Outdated
The Sysl open source setup | ||
====================== | ||
|
||
We have recently set up what we think of as good engineering practises for our enterprise-backed open source project [Sysl](https://github.com/anz-bank/sysl). The following is a record of systems and practises we consider essential and the products and platforms we have chosen (in parenthesis): |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
s/think of as/consider to be/
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done, but then we've got a word repetition in the first 2 sentences. So changed the second one to deem which os a strange word, isn't it?
docs/blog/setup.md
Outdated
|
||
The most involved pieces have been automated quality ensurance and release automation. These parts of the Sysl project also keep evolving as we add new quality checks and artefact types. They deserve a closer look. | ||
|
||
Our branch model is simple - we develop feature branches on our own forks and issue pull requests to `master` on `anz-bank/sysl`. As suggested by [Github Flow](https://guides.github.com/introduction/flow/), "[t]here's only one rule: anything in the master branch is always deployable". Releases are linked to tags of commits in `master` on `anz-bank/sysl`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
*There's
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
docs/blog/setup.md
Outdated
|
||
Our branch model is simple - we develop feature branches on our own forks and issue pull requests to `master` on `anz-bank/sysl`. As suggested by [Github Flow](https://guides.github.com/introduction/flow/), "[t]here's only one rule: anything in the master branch is always deployable". Releases are linked to tags of commits in `master` on `anz-bank/sysl`. | ||
|
||
Our original (upsteram, parent) repository is owned by the Github orgaisation [`anz-bank`](https://github.com/anz-bank), which has got a `sysl-developer` team. Only team members have write access to `anz-bank/sysl` and can merge pull requests into `master`. Additionally, the `master` branch of `anz-bank/sysl` is protected and has restrictions enabled to automate quality checks: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- *upstream
- *organization
- s/has got a/has a/
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done, done, done
docs/blog/setup.md
Outdated
|
||
Sysl releases are available on Sysl's [Github releases page](https://github.com/anz-bank/sysl/releases) and on various package registries (e.g. PyPI, BinTray, Docker Hub). We follow [Semver](https://semver.org/) for versioning. | ||
|
||
Our release process has been automated with a script and artefact deployment by CI. A new release can be started with `src/scripts/release.sh prepare X.Y.Z` and after the automatically generated pull request is approved and merged `src/scripts/release.sh deploy X.Y.Z` will create and push the release tag which will then trigger Travis and Appveyor to deploy the artefacts (see our [Releasing documentation](https://github.com/anz-bank/sysl/blob/master/docs/releasing.md) for more details). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
s/with a script/with script/
s/ and after/. After/
s/merged\t/merged, /
s/tag which/tag, which/
s/our/the/
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done.
Rendered MarkDown at https://github.com/juliaogris/sysl/blob/blog-setup/docs/blog/setup.md