Skip to content
This repository has been archived by the owner on May 1, 2024. It is now read-only.

Latest commit

 

History

History
177 lines (124 loc) · 6.38 KB

RELEASE.md

File metadata and controls

177 lines (124 loc) · 6.38 KB
Raw

How to Release

Releasing the project requires these steps:

Note that the current release steps require a Windows system with a bash client (such as the one included with Git for Windows).

  1. Upgrade dependency versions as necessary. (See: npm audit)
  2. Validate the auto-update functionality still works for the new version of the app using the testSimpleUpdater-win32-x64.sh script (Note this will reinstall Cucumber Forge Desktop locally)
  3. Run npm version *major|minor|patch* (this project uses semantic versioning)
  4. Push new commit to main and push the newly created tag (this will trigger a Travis build)
  5. Wait for the Travis build to complete
  6. Add changelog information to the GitHub release (include relevant changes from cucumber-forge-report-generator)
  7. Update the versions in the updates.json file to reflect the new release version (this will trigger the clients to auto-update)
  8. Install an older version of the app and verify that it properly auto-updates

GitHub Release Template

Tag Version: vX.X.X
Release Title: vX.X.X

## [X.X.X](https://github.com/cerner/cucumber-forge-desktop/compare/vX.X.W...vX.X.X) (YEAR-MO-DAY)


### Bug Fixes
* **app:** Commit message ([#issue](https://github.com/cerner/cucumber-forge-desktop/issues/#issue)) ([commit-hash](https://github.com/cerner/cucumber-forge-desktop/commit/commit-hash))

### Features
* **report:** Commit message ([#issue](https://github.com/cerner/cucumber-forge-report-generator/issues/#issue)) ([commit-hash](https://github.com/cerner/cucumber-forge-report-generator/commit/commit-hash))

### BREAKING CHANGES
* **app:** Commit message ([#issue](https://github.com/cerner/cucumber-forge-desktop/issues/#issue)) ([commit-hash](https://github.com/cerner/cucumber-forge-desktop/commit/commit-hash))

Merging PRs to main

This project uses the AngularJS commit message standards. They should should be applied to all commit messages for the main branch.

Format of the commit message

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

Message header

The message header is a single line that contains succinct description of the change containing a type, an optional scope and a subject.

<type>

This describes the kind of change that this commit is providing.

  • feat (feature)
  • fix (bug fix)
  • docs (documentation)
  • style (formatting, missing semi colons, …)
  • refactor
  • test (when adding missing tests)
  • chore (maintain)

<scope>

Scope can be anything specifying place of the commit change. For example $location, $browser, $compile, $rootScope, ngHref, ngClick, ngView, etc...

You can use * if there isn't a more fitting scope.

<subject>

This is a very short description of the change.

  • Use imperative, present tense: “change” not “changed” nor “changes”
  • Don't capitalize first letter
  • No dot (.) at the end

Message body

  • Just as in <subject> use imperative, present tense: “change” not “changed” nor “changes”
  • Includes motivation for the change and contrasts with previous behavior

Message footer

Breaking changes

All breaking changes have to be mentioned as a breaking change block in the footer, which should start with the word BREAKING CHANGE: with a space or two newlines. The rest of the commit message is then the description of the change, justification and migration notes.

Referencing issues

Closed bugs should be listed on a separate line in the footer prefixed with Closes keyword like this:

Closes #234

Or in case of multiple issues:

Closes #123, #245, #992

Examples

--------------------------------------------------------------------------------
feat($browser): onUrlChange event (popstate/hashchange/polling)

Added new event to $browser:
- forward popstate event if available
- forward hashchange event if popstate not available
- do polling when neither popstate nor hashchange available

Breaks $browser.onHashChange, which was removed (use onUrlChange instead)
--------------------------------------------------------------------------------
fix($compile): couple of unit tests for IE9

Older IEs serialize html uppercased, but IE9 does not...
Would be better to expect case insensitive, unfortunately jasmine does
not allow to user regexps for throw expectations.

Closes #392
Breaks foo.bar api, foo.baz should be used instead
--------------------------------------------------------------------------------
feat(directive): ng:disabled, ng:checked, ng:multiple, ng:readonly, ng:selected

New directives for proper binding these attributes in older browsers (IE).
Added coresponding description, live examples and e2e tests.

Closes #351
--------------------------------------------------------------------------------
style($location): add couple of missing semi colons
--------------------------------------------------------------------------------
docs(guide): updated fixed docs from Google Docs

Couple of typos fixed:
- indentation
- batchLogbatchLog -> batchLog
- start periodic checking
- missing brace
--------------------------------------------------------------------------------
feat($compile): simplify isolate scope bindings

Changed the isolate scope binding options to:
  - @attr - attribute binding (including interpolation)
  - =model - by-directional model binding
  - &expr - expression execution binding

This change simplifies the terminology as well as
number of choices available to the developer. It
also supports local name aliasing from the parent.

BREAKING CHANGE: isolate scope bindings definition has changed and
the inject option for the directive controller injection was removed.

To migrate the code follow the example below:

Before:

scope: {
  myAttr: 'attribute',
  myBind: 'bind',
  myExpression: 'expression',
  myEval: 'evaluate',
  myAccessor: 'accessor'
}

After:

scope: {
  myAttr: '@',
  myBind: '@',
  myExpression: '&',
  // myEval - usually not useful, but in cases where the expression is assignable, you can use '='
  myAccessor: '=' // in directive's template change myAccessor() to myAccessor
}

The removed `inject` wasn't generally useful for directives so there should be no code using it.
--------------------------------------------------------------------------------