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

Commit

Permalink
docs(changelog,build,commit-levels,readme): updates for v1.1.6
Browse files Browse the repository at this point in the history
add contributors to changelog
refine release process in readme
add npm script for building contributor list for a release
for example use `npm run contributors:release -- 2017-09-07` for v1.1.6
fix broken headers in Build docs
fix theming guide link in Build docs
update Commit Levels doc to the current state of the project
fix note in contributors page to match actual sorting
  • Loading branch information
Splaktar committed Jan 18, 2018
1 parent cc73422 commit e47aa1c
Show file tree
Hide file tree
Showing 7 changed files with 47 additions and 27 deletions.
15 changes: 15 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,21 @@

* **datepicker:** add the ability to restrict users to a calendar view ([#9736](https://github.com/angular/material/issues/9736)) ([eecc976](https://github.com/angular/material/commit/eecc976)), closes [#9260](https://github.com/angular/material/issues/9260)

#### Contributors

Thank you to the excellent contributors who helped with the v1.1.6 release:

[<img alt="crisbeto" src="https://avatars0.githubusercontent.com/u/4450522?v=4&s=117" width="117">](https://github.com/crisbeto) |[<img alt="jelbourn" src="https://avatars3.githubusercontent.com/u/838736?v=4&s=117" width="117">](https://github.com/jelbourn) |[<img alt="EladBezalel" src="https://avatars3.githubusercontent.com/u/6004537?v=4&s=117" width="117">](https://github.com/EladBezalel) |[<img alt="Splaktar" src="https://avatars1.githubusercontent.com/u/3506071?v=4&s=117" width="117">](https://github.com/Splaktar) |[<img alt="alopezsanchez" src="https://avatars3.githubusercontent.com/u/15221596?v=4&s=117" width="117">](https://github.com/alopezsanchez) |[<img alt="Phoqe" src="https://avatars3.githubusercontent.com/u/7033377?v=4&s=117" width="117">](https://github.com/Phoqe) |
:---: |:---: |:---: |:---: |:---: |:---: |
[crisbeto](https://github.com/crisbeto) |[jelbourn](https://github.com/jelbourn) |[EladBezalel](https://github.com/EladBezalel) |[Splaktar](https://github.com/Splaktar) |[alopezsanchez](https://github.com/alopezsanchez) |[Phoqe](https://github.com/Phoqe) |

[<img alt="oliversalzburg" src="https://avatars2.githubusercontent.com/u/1658949?v=4&s=117" width="117">](https://github.com/oliversalzburg) |[<img alt="graingert" src="https://avatars3.githubusercontent.com/u/413772?v=4&s=117" width="117">](https://github.com/graingert) |[<img alt="dulynoded" src="https://avatars0.githubusercontent.com/u/11513504?v=4&s=117" width="117">](https://github.com/dulynoded) |[<img alt="Ardeshir81" src="https://avatars3.githubusercontent.com/u/5755214?v=4&s=117" width="117">](https://github.com/Ardeshir81) |[<img alt="beetlerom" src="https://avatars3.githubusercontent.com/u/1420091?v=4&s=117" width="117">](https://github.com/beetlerom) |[<img alt="davestacey" src="https://avatars3.githubusercontent.com/u/754281?v=4&s=117" width="117">](https://github.com/davestacey) |
:---: |:---: |:---: |:---: |:---: |:---: |
[oliversalzburg](https://github.com/oliversalzburg) |[graingert](https://github.com/graingert) |[dulynoded](https://github.com/dulynoded) |[Ardeshir81](https://github.com/Ardeshir81) |[beetlerom](https://github.com/beetlerom) |[davestacey](https://github.com/davestacey) |

[<img alt="phistuck" src="https://avatars0.githubusercontent.com/u/184400?v=4&s=117" width="117">](https://github.com/phistuck) |[<img alt="wangsha" src="https://avatars0.githubusercontent.com/u/221029?v=4&s=117" width="117">](https://github.com/wangsha) |[<img alt="alphatwit" src="https://avatars1.githubusercontent.com/u/3231066?v=4&s=117" width="117">](https://github.com/alphatwit) |[<img alt="andrewseguin" src="https://avatars3.githubusercontent.com/u/22898577?v=4&s=117" width="117">](https://github.com/andrewseguin) |
:---: |:---: |:---: |:---: |
[phistuck](https://github.com/phistuck) |[wangsha](https://github.com/wangsha) |[alphatwit](https://github.com/alphatwit) |[andrewseguin](https://github.com/andrewseguin) |


<a name="1.1.5"></a>
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,13 +50,13 @@ The patch builds (1.0.4, 1.0.5, 1.0.6) are prepared based on commits in the `pat

The minor build (1.1.0, 1.2.0, 1.3.0,...) are prepared based on commits in the `master` branch; which will remain the daily development branch AND will be the source for the `minor` releases.

Our formal release of `minor` builds is much less frequent; probably 1x / Quarter. Developers can easily obtain the latest, full change-set from bower or npm using references to `@master`.
Our formal release of `minor` builds is much less frequent. Developers can easily obtain the latest, full change-set from bower or npm using references to `@master`.

##### Changelog

The Changelog may contain releases for `patch` or `minor`. If you do not see a fix listed in the Changelog but the issue has been resolved or the PR merged, then those changes will be `master` available in the next *minor* release.

> for the purposes of AngularJS Material, you *could* think of the patch releases as being *minor* changes and the 'minor' releases as being *major* changes.
> For the purposes of AngularJS Material, you *could* think of the patch releases as being *minor* changes and the 'minor' releases as being *major* changes.

## <a name="contributing"></a> Contributing
Expand Down
4 changes: 2 additions & 2 deletions docs/app/partials/contributors.tmpl.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@

<h2>Contributors</h2>

<p style="margin-top:-10px;"> (sorted by GitHub name)</p>
<p style="margin-top:-10px;"> (sorted by number of commits)</p>
<br/>

<div class="contributor_tables">

<!-- User the 'contributors.json' generated by 'npm run contributors' -->
<!-- Use the 'contributors.json' generated by 'gulp build-contributors' -->

<table ng-repeat="row in github.contributors">
<thead>
Expand Down
14 changes: 7 additions & 7 deletions docs/guides/BUILD.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ The following command line tasks are available:
- `gulp karma` to test once
- `gulp karma-watch` to test & watch for changes

###<a name="livedocs"></a> Building the Documentation
### <a name="livedocs"></a> Building the Documentation

The AngularJS Material **Live Docs** are generated from the source code and demos and actually use the
AngularJS Material components and themes.
Expand All @@ -50,7 +50,7 @@ AngularJS Material components and themes.

See the [Building the Live Documentation](../README.md#docs) document for details.

###<a name="builds"></a> Building the Library
### <a name="builds"></a> Building the Library

Developers can build the entire AngularJS Material library or individual component modules. The
library comprises:
Expand Down Expand Up @@ -79,7 +79,7 @@ gulp build
gulp build --release
```

###<a name="bower"></a> Using the Library with Bower
### <a name="bower"></a> Using the Library with Bower

For developers not interested in building the AngularJS Material library, use **bower** to install and
use the AngularJS Material distribution files.
Expand Down Expand Up @@ -109,7 +109,7 @@ dependencies.
For example, the **slider** component is registered as a **material.components.slider** module.

###<a name="comp_builds"></a> Building Individual Components
### <a name="comp_builds"></a> Building Individual Components

To build and deploy assets for each component individually, run the command

Expand Down Expand Up @@ -159,7 +159,7 @@ and JS from both the **slider** and the **core** modules:
-- slider-default-theme.css
```

###<a name="comp_debug"></a> Component Debugging
### <a name="comp_debug"></a> Component Debugging

Debugging a demo in the Live Docs is complicated due the multiple demos loading and initializing. A
more practical approach is to open and debug a specific, standalone Component demo.
Expand Down Expand Up @@ -199,6 +199,6 @@ After running `gulp server` to start a *LiveReload* server in your project root:
* Open Dev Tools and debug...


##<a name="themes"></a> Theming
## <a name="themes"></a> Theming

https://material.angularjs.org/#/Theming/01_introduction
[Go to the Theming Guide](https://material.angularjs.org/latest/Theming/01_introduction)
34 changes: 19 additions & 15 deletions docs/guides/COMMIT_LEVELS.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,23 +26,27 @@ AngularJS Material uses a "Pull Request" process to allow team leaders opportuni
The development team has defined three (3) Github levels of **commit authorization** within [Angular/Material](https://github.com/angular/material/):

* General:
* Developers in this group includes any team members not listed under Core or Team Leads below
* For any and all changes, developers must use a fork of the AngularJS Material repository
* Please do not make or submit any changes from the master branch.
* Developers in this group includes any team members not listed under Team Leads or Caretakers below
* For any and all changes, developers must use a feature branch from a fork of the AngularJS Material repository
* Please do not make or submit any changes from the master branch of your fork
* Are not authorized to merge PRs
* Should not reassign issue or change issue milestones
* Should ensure their issue labels are correct
* Should ensure their issues are tested with latest HEAD versions of AngularJS Material
* Should ensure their issues are tested with latest releases of AngularJS (1.3.x, 1.4.x, 1.5.x)
* Core:
* Includes: [Topher Fangio](https://github.com/topherfangio), [Elad Bezalel](https://github.com/eladbezalel)
* Should not merge PRs (unless explicitly requested)
* Should use AngularJS Material branches for major, non-trivial changes.
* For minor changes, developers in this group may elect to commit direct to master.
* Team Leads:
* Includes: [Naomi Black](https://github.com/naomiblack), [Thomas Burleson](https://github.com/ThomasBurleson), [Jeremy Elbourn](https://github.com/jelbourn)
* May review PRs
* ThomasBurleson is the primary PR reviewer
* Should ensure their issues are tested with latest releases of AngularJS (1.5.x, 1.6.x)
* Team Leads:
* Includes: [Michael Prentice](https://github.com/splaktar)
* Are not authorized to merge PRs
* Should assign issues and change issue milestones
* Should ensure issue labels are correct
* Should review PRs
* Michael Prentice is the primary PR reviewer
* Should confirm Karma tests pass
* Google Caretakers:
* Includes: [Jeremy Elbourn](https://github.com/jelbourn), [Andrew Seguin](https://github.com/andrewseguin), [Joey Perrott](https://github.com/josephperrott), [Tina Yuangao](https://github.com/tinayuangao)
* Should review PRs
* Should confirm Karma tests pass
* Should squash as need
* Should ensure the PR is closed when the merge finishes.
* Should squash as needed
* Should ensure the PR is closed when the merge finishes
* Should create releases
* Should add release assets to the Google CDN
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@
},
"scripts": {
"build": "gulp build",
"contributors:release": "githubcontrib --owner angular --repo material --cols 6 --format md --showlogin true --sha master --sortOrder desc --fromDate ",
"docs:build": "gulp docs",
"docs:watch": "gulp watch site --dev",
"test:fast": "gulp karma-fast",
Expand Down

0 comments on commit e47aa1c

Please sign in to comment.