autonomic-cooperative
/
autonomic.zone
Archived
5
0
Fork 0
Code Issues 15 Pull Requests 2 Releases Activity

Updated README to reflect our new CI setup

This commit is contained in:
georgeowell 2018-11-21 01:41:43 +00:00
parent 1f3ada29d7
commit 9c4166e573
1 changed files with 8 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
README.md
View File

@ -2,58 +2,28 @@
# autonomic-cooperative.gitlab.io
A [Jekyll] based site for the Autonomic Cooperative.
A [Jekyll] based site for the Autonomic Cooperative. The site is based on the [spectral-jekyll-theme] template.
The template is based on the [spectral-jekyll-theme].
We use [autonomic.zone] for production and [autonomic-cooperative.gitlab.io] for staging.
We use [autonomic.zone] for production. We used to use [autonomic-cooperative.gitlab.io] as staging but this isn't really needed anymore.
[Jekyll]: https://jekyllrb.com/
[spectral-jekyll-theme]: https://github.com/andrewbanchich/spectral-jekyll-theme
[autonomic.zone]: https://autonomic.zone/
[autonomic-cooperative.gitlab.io]: http://autonomic-cooperative.gitlab.io/
# Contribute
# Make a change
Please see [CONTRIBUTING.md] for the juicy details.
[CONTRIBUTING.md]: https://gitlab.com/autonomic-cooperative/autonomic-cooperative.gitlab.io/blob/master/CONTRIBUTING.md
# Make A New Release
Please add a new [change log] entry. This helps us track released changes easily.
[change log]: https://gitlab.com/autonomic-cooperative/autonomic-cooperative.gitlab.io/blob/master/CHANGELOG.md
Then, [tag a new commit] and send it upstream with:
[tag a new commit]: https://git-scm.com/book/en/v2/Git-Basics-Tagging
[semantic versioning]: http://semver.org/
```bash
$ COMMIT=$(git rev-parse HEAD)
$ TAG=6.6.6 # enter your new tag
$ git tag -a $TAG $COMMIT
$ git push upstream master --tags
```
You can also use the [Gitlab tags UI] for this.
[Gitlab tags UI]: https://gitlab.com/autonomic-cooperative/autonomic-cooperative.gitlab.io/tags
Our [deploy] CI stage will push the new site to [the production branch].
Work on features in branches. If you commit to master, make a merge request. Our [deploy] CI stage will push any changes on master to [autonomic.zone].
[deploy]: https://gitlab.com/autonomic-cooperative/autonomic-cooperative.gitlab.io/blob/d16aec42bd2ddd7449f55d9f06b03499cc660b22/.gitlab-ci.yml#L17
[the production branch]: https://gitlab.com/autonomic-cooperative/autonomic-cooperative.gitlab.io/tree/production
Watch the [CI/CD pipeline] to see that it builds successfully.
[CI/CD pipeline]: https://gitlab.com/autonomic-cooperative/autonomic-cooperative.gitlab.io/pipelines
Then head over to [fullyautomatedluxuryinfrastructure] and run:
[fullyautomatedluxuryinfrastructure]: https://gitlab.com/autonomic-cooperative/fullyautomatedluxuryinfrastructure
# Contribute
``` bash
$ ansible-playbook orgs/autonomic/gitlabpages.yml
```
Please see [CONTRIBUTING.md] for the juicy details. It may need to be updated so please submit patches if you discover some quirk!
[CONTRIBUTING.md]: https://gitlab.com/autonomic-cooperative/autonomic-cooperative.gitlab.io/blob/master/CONTRIBUTING.md