Skip to content

Commit 7d3aa19

Browse files
myiimyii
committed
feat: implement semantic-release 
1 parent bf6a653 commit 7d3aa19

11 files changed

+1070
-64
lines changed

‎.gitignore

+110-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,110 @@
1-
.kitchen/
2-
*.swp
3-
*.swo
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
env/
12+
build/
13+
develop-eggs/
14+
dist/
15+
downloads/
16+
eggs/
17+
.eggs/
18+
lib/
19+
lib64/
20+
parts/
21+
sdist/
22+
var/
23+
wheels/
24+
*.egg-info/
25+
.installed.cfg
26+
*.egg
27+
28+
# PyInstaller
29+
# Usually these files are written by a python script from a packager
30+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
31+
*.manifest
32+
*.spec
33+
34+
# Installer logs
35+
pip-log.txt
36+
pip-delete-this-directory.txt
37+
38+
# Unit test / coverage reports
39+
htmlcov/
40+
.tox/
41+
.coverage
42+
.coverage.*
43+
.cache
44+
nosetests.xml
45+
coverage.xml
46+
*.cover
47+
.hypothesis/
48+
.kitchen
49+
.kitchen.local.yml
50+
kitchen.local.yml
51+
52+
# Translations
53+
*.mo
54+
*.pot
55+
56+
# Django stuff:
57+
*.log
58+
local_settings.py
59+
60+
# Flask stuff:
61+
instance/
62+
.webassets-cache
63+
64+
# Scrapy stuff:
65+
.scrapy
66+
67+
# Sphinx documentation
68+
docs/_build/
69+
70+
# PyBuilder
71+
target/
72+
73+
# Jupyter Notebook
74+
.ipynb_checkpoints
75+
76+
# pyenv
77+
.python-version
78+
79+
# celery beat schedule file
80+
celerybeat-schedule
81+
82+
# SageMath parsed files
83+
*.sage.py
84+
85+
# dotenv
86+
.env
87+
88+
# virtualenv
89+
.venv
90+
venv/
91+
ENV/
92+
93+
# Spyder project settings
94+
.spyderproject
95+
.spyproject
96+
97+
# Rope project settings
98+
.ropeproject
99+
100+
# mkdocs documentation
101+
/site
102+
103+
# mypy
104+
.mypy_cache/
105+
106+
# copied `.md` files used for conversion to `.rst` using `m2r`
107+
docs/*.md
108+
109+
# Vim
110+
*.sw[nop]

‎.travis.yml

+35-35
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
stages:
22
- test
3-
# - commitlint
4-
# - name: release
5-
# if: branch = master AND type != pull_request
3+
- commitlint
4+
- name: release
5+
if: branch = master AND type != pull_request
66

77
sudo: required
88
cache: bundler
@@ -41,36 +41,36 @@ env:
4141
script:
4242
- bundle exec kitchen verify ${INSTANCE}
4343

44-
# jobs:
45-
# include:
46-
# # Define the commitlint stage
47-
# - stage: commitlint
48-
# language: node_js
49-
# node_js: lts/*
50-
# before_install: skip
51-
# script:
52-
# - npm install @commitlint/config-conventional -D
53-
# - npm install @commitlint/travis-cli -D
54-
# - commitlint-travis
55-
# # Define the release stage that runs semantic-release
56-
# - stage: release
57-
# language: node_js
58-
# node_js: lts/*
59-
# before_install: skip
60-
# script:
61-
# # Update `AUTHORS.md`
62-
# - export MAINTAINER_TOKEN=${GH_TOKEN}
63-
# - go get github.com/myii/maintainer
64-
# - maintainer contributor
65-
#
66-
# # Install all dependencies required for `semantic-release`
67-
# - npm install @semantic-release/changelog@3 -D
68-
# - npm install @semantic-release/exec@3 -D
69-
# - npm install @semantic-release/git@7 -D
70-
# deploy:
71-
# provider: script
72-
# skip_cleanup: true
73-
# script:
74-
# # Run `semantic-release`
75-
# - npx semantic-release@15
44+
jobs:
45+
include:
46+
# Define the commitlint stage
47+
- stage: commitlint
48+
language: node_js
49+
node_js: lts/*
50+
before_install: skip
51+
script:
52+
- npm install @commitlint/config-conventional -D
53+
- npm install @commitlint/travis-cli -D
54+
- commitlint-travis
55+
# Define the release stage that runs semantic-release
56+
- stage: release
57+
language: node_js
58+
node_js: lts/*
59+
before_install: skip
60+
script:
61+
# Update `AUTHORS.md`
62+
- export MAINTAINER_TOKEN=${GH_TOKEN}
63+
- go get github.com/myii/maintainer
64+
- maintainer contributor
65+
66+
# Install all dependencies required for `semantic-release`
67+
- npm install @semantic-release/changelog@3 -D
68+
- npm install @semantic-release/exec@3 -D
69+
- npm install @semantic-release/git@7 -D
70+
deploy:
71+
provider: script
72+
skip_cleanup: true
73+
script:
74+
# Run `semantic-release`
75+
- npx semantic-release@15
7676

‎FORMULA

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
name: postgres
2+
os: Debian, Ubuntu, Raspbian, RedHat, Fedora, CentOS, Suse, openSUSE, Gentoo, Funtoo, Arch, Manjaro, Alpine, FreeBSD, OpenBSD, Solaris, SmartOS, Windows, MacOS
3+
os_family: Debian, RedHat, Suse, Gentoo, Arch, Alpine, FreeBSD, OpenBSD, Solaris, Windows, MacOS
4+
version: 0.36.0
5+
release: 1
6+
minimum_version: 2016.11
7+
summary: Postgres formula
8+
description: Formula to install and configure PostgreSQL
9+
top_level_dir: postgres

‎commitlint.config.js

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
module.exports = {
2+
extends: ['@commitlint/config-conventional'],
3+
};

‎docs/CONTRIBUTING.rst

+158
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,158 @@
1+
.. _contributing:
2+
3+
How to contribute
4+
=================
5+
6+
This document will eventually outline all aspects of guidance to make your contributing experience a fruitful and enjoyable one.
7+
What it already contains is information about *commit message formatting* and how that directly affects the numerous automated processes that are used for this repo.
8+
It also covers how to contribute to this *formula's documentation*.
9+
10+
.. contents:: **Table of Contents**
11+
12+
Overview
13+
--------
14+
15+
Submitting a pull request is more than just code!
16+
To achieve a quality product, the *tests* and *documentation* need to be updated as well.
17+
An excellent pull request will include these in the changes, wherever relevant.
18+
19+
Commit message formatting
20+
-------------------------
21+
22+
Since every type of change requires making Git commits,
23+
we will start by covering the importance of ensuring that all of your commit
24+
messages are in the correct format.
25+
26+
Automation of multiple processes
27+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
28+
29+
This formula uses `semantic-release <https://github.com/semantic-release/semantic-release>`_ for automating numerous processes such as bumping the version number appropriately, creating new tags/releases and updating the changelog.
30+
The entire process relies on the structure of commit messages to determine the version bump, which is then used for the rest of the automation.
31+
32+
Full details are available in the upstream docs regarding the `Angular Commit Message Conventions <https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines>`_.
33+
The key factor is that the first line of the commit message must follow this format:
34+
35+
.. code-block::
36+
37+
type(scope): subject
38+
39+
40+
* E.g. ``docs(contributing): add commit message formatting instructions``.
41+
42+
Besides the version bump, the changelog and release notes are formatted accordingly.
43+
So based on the example above:
44+
45+
..
46+
47+
.. raw:: html
48+
49+
<h3>Documentation</h3>
50+
51+
* **contributing:** add commit message formatting instructions
52+
53+
54+
* The ``type`` translates into a ``Documentation`` sub-heading.
55+
* The ``(scope):`` will be shown in bold text without the brackets.
56+
* The ``subject`` follows the ``scope`` as standard text.
57+
58+
Linting commit messages in Travis CI
59+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
60+
61+
This formula uses `commitlint <https://github.com/conventional-changelog/commitlint>`_ for checking commit messages during CI testing.
62+
This ensures that they are in accordance with the ``semantic-release`` settings.
63+
64+
For more details about the default settings, refer back to the ``commitlint`` `reference rules <https://conventional-changelog.github.io/commitlint/#/reference-rules>`_.
65+
66+
Relationship between commit type and version bump
67+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
68+
69+
This formula applies some customisations to the defaults, as outlined in the table below,
70+
based upon the `type <https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#type>`_ of the commit:
71+
72+
.. list-table::
73+
:name: commit-type-vs-version-bump
74+
:header-rows: 1
75+
:stub-columns: 0
76+
:widths: 1,2,3,1,1
77+
78+
* - Type
79+
- Heading
80+
- Description
81+
- Bump (default)
82+
- Bump (custom)
83+
* - ``build``
84+
- Build System
85+
- Changes related to the build system
86+
- –
87+
-
88+
* - ``chore``
89+
- –
90+
- Changes to the build process or auxiliary tools and libraries such as
91+
documentation generation
92+
- –
93+
-
94+
* - ``ci``
95+
- Continuous Integration
96+
- Changes to the continuous integration configuration
97+
- –
98+
-
99+
* - ``docs``
100+
- Documentation
101+
- Documentation only changes
102+
- –
103+
- 0.0.1
104+
* - ``feat``
105+
- Features
106+
- A new feature
107+
- 0.1.0
108+
-
109+
* - ``fix``
110+
- Bug Fixes
111+
- A bug fix
112+
- 0.0.1
113+
-
114+
* - ``perf``
115+
- Performance Improvements
116+
- A code change that improves performance
117+
- 0.0.1
118+
-
119+
* - ``refactor``
120+
- Code Refactoring
121+
- A code change that neither fixes a bug nor adds a feature
122+
- –
123+
- 0.0.1
124+
* - ``revert``
125+
- Reverts
126+
- A commit used to revert a previous commit
127+
- –
128+
- 0.0.1
129+
* - ``style``
130+
- Styles
131+
- Changes that do not affect the meaning of the code (white-space,
132+
formatting, missing semi-colons, etc.)
133+
- –
134+
- 0.0.1
135+
* - ``test``
136+
- Tests
137+
- Adding missing or correcting existing tests
138+
- –
139+
- 0.0.1
140+
141+
Use ``BREAKING CHANGE`` to trigger a ``major`` version change
142+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
143+
144+
Adding ``BREAKING CHANGE`` to the footer of the extended description of the commit message will **always** trigger a ``major`` version change, no matter which type has been used.
145+
This will be appended to the changelog and release notes as well.
146+
To preserve good formatting of these notes, the following format is prescribed:
147+
148+
* ``BREAKING CHANGE: <explanation in paragraph format>.``
149+
150+
An example of that:
151+
152+
.. code-block:: git
153+
154+
...
155+
156+
BREAKING CHANGE: With the removal of all of the `.sls` files under
157+
`template package`, this formula no longer supports the installation of
158+
packages.

0 commit comments

Comments
 (0)