This repository has been archived by the owner on May 4, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update skill documentation & metadata
Separate skill documentation into README, INFO, and SETTINGS. Use metadata from package.json.
- Loading branch information
David Dooling
committed
Nov 18, 2020
1 parent
ab172b5
commit 376d1a4
Showing
5 changed files
with
119 additions
and
62 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
Enable ChatOps for all of your GitHub repository activity. This skill will | ||
streamline the process of creating channels, linking them to repositories and | ||
inviting repository contributors to the channels. | ||
|
||
When channels are linked to repositories, you get actionable notifications from | ||
the | ||
[GitHub Notifications](https://go.atomist.com/catalog/skills/atomist/github-notifications-skill) | ||
skill. | ||
|
||
- Saves you time by setting up ChatOps for your team's GitHub activity | ||
- Increase visibility into what's happening in your repositories across your | ||
organization | ||
|
||
Enable the skill, commit and push changes to your GitHub repositories, and then | ||
see how the skill creates channels and invites colleagues who work on the same | ||
repositories! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,93 +1,81 @@ | ||
# `atomist/auto-link-channel-skill` | ||
|
||
<!---atomist-skill-description:start---> | ||
Link chat channels to GitHub repositories. | ||
|
||
Link chat channels to GitHub repositories | ||
:sparkles: [_**View this skill in the Atomist Skills Catalog**_][atomist-skill] | ||
to enable this skill on your repositories. :sparkles: | ||
|
||
<!---atomist-skill-description:end---> | ||
See the [Atomist website][atomist] for general information about Atomist Skills | ||
and the [Atomist documentation site][atomist-doc] for instructions on how to get | ||
started using Atomist Skills. | ||
|
||
--- | ||
|
||
<!---atomist-skill-readme:start---> | ||
|
||
# What it's useful for | ||
|
||
Enable ChatOps for all of your GitHub repository activity. This skill will | ||
streamline the process of creating channels, linking them to repositories and | ||
inviting repository contributors to the channels. | ||
|
||
When channels are linked to repositories, you get actionable notifications from | ||
the | ||
[GitHub Notifications](https://go.atomist.com/catalog/skills/atomist/github-notifications-skill) | ||
skill. | ||
|
||
- Saves you time by setting up ChatOps for your team's GitHub activity | ||
- Increase visibility into what's happening in your repositories across your | ||
organization | ||
[atomist-skill]: | ||
https://go.atomist.com/catalog/skills/atomist/auto-link-channel-skill | ||
"Atomist Skills Catalog - Automate All Your Software Tasks" | ||
[atomist-doc]: https://docs.atomist.com/ "Atomist Documentation" | ||
|
||
# Before you get started | ||
## Contributing | ||
|
||
Connect and configure this integration: | ||
Contributions to this project from community members are encouraged and | ||
appreciated. Please review the [Contributing Guidelines](CONTRIBUTING.md) for | ||
more information. Also see the [Development](#development) section in this | ||
document. | ||
|
||
1. **GitHub** | ||
1. **Slack or Microsoft Teams** | ||
## Code of conduct | ||
|
||
The **GitHub** integration must be configured in order to use this skill. At | ||
least one repository must be selected. The **Slack** or **Microsoft Teams** | ||
integration are required to successfully link channels. | ||
This project is governed by the [Code of Conduct](CODE_OF_CONDUCT.md). You are | ||
expected to act in accordance with this code by participating. Please report any | ||
unacceptable behavior to [email protected]. | ||
|
||
We recommend installing the | ||
[GitHub Notifications](https://go.atomist.com/catalog/skills/atomist/github-notifications-skill) | ||
skill in order to receive notifications for your GitHub activity. | ||
## Connect | ||
|
||
# How to configure | ||
Follow [@atomist][atomist-twitter] on Twitter and [The Atomist | ||
Blog][atomist-blog]. | ||
|
||
1. **Always invite committers** | ||
[atomist-twitter]: https://twitter.com/atomist "Atomist on Twitter" | ||
[atomist-blog]: https://blog.atomist.com/ "The Atomist Blog" | ||
|
||
With this setting you can control if you want the skill to always invite | ||
chat users to linked channels when they push to repositories. | ||
## Support | ||
|
||
1. **Allow committers to opt out** | ||
General support questions should be discussed in the `#support` channel in the | ||
[Atomist community Slack workspace][slack]. | ||
|
||
Some committers might not want to get invited to channels when they commit | ||
and push to repositories. GitHub logins or chat user names of such uers can | ||
be added here to prevent invitations to go out. | ||
If you find a problem, please create an [issue](../../issues). | ||
|
||
1. **Prefix channel names** | ||
## Development | ||
|
||
Use this setting to prefix the names of newly created channels for better | ||
grouping. | ||
You will need to install [Node.js][node] to build and test this project. | ||
|
||
By default, this skill creates channels named after the repository. Manually | ||
renamed or linked channels will not get renamed. | ||
[node]: https://nodejs.org/ "Node.js" | ||
|
||
1. **Determine repository scope** | ||
### Build and test | ||
|
||
By default, this skill will be enabled for all repositories in all | ||
organizations you have connected. | ||
Install dependencies. | ||
|
||
To restrict the organizations or specific repositories on which the skill | ||
will run, you can explicitly choose organization(s) and repositories. | ||
``` | ||
$ npm ci | ||
``` | ||
|
||
# How to manage linked channels and invite users | ||
Use the `build` package script to compile, test, lint, and build the | ||
documentation. | ||
|
||
1. **Set up the skill** | ||
``` | ||
$ npm run build | ||
``` | ||
|
||
1. **Commit and push changes to your GitHub repositories** | ||
### Release | ||
|
||
1. **See how the skill creates channels and invites colleagues who work on the | ||
same repositories!** | ||
Releases are created by pushing a release [semantic version][semver] tag to the | ||
repository, Atomist Skills take care of the rest. | ||
|
||
To create feature requests or bug reports, create an | ||
[issue in the repository for this skill](https://github.com/atomist-skills/npm-license-usage-skill/issues). | ||
See the [code](https://github.com/atomist-skills/npm-license-usage-skill) for | ||
the skill. | ||
To make this skill globally available, set its maturity to "stable" via the set | ||
maturity drop-down in its Atomist Community Slack channel. | ||
|
||
<!---atomist-skill-readme:end---> | ||
[semver]: https://semver.org/ "Semantic Version" | ||
|
||
--- | ||
|
||
Created by [Atomist][atomist]. Need Help? [Join our Slack workspace][slack]. | ||
|
||
[atomist]: https://atomist.com/ "Atomist - How Teams Deliver Software" | ||
[atomist]: https://atomist.com/ "Atomist - Automate All the Software Things" | ||
[slack]: https://join.atomist.com/ "Atomist Community Slack" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
## Before you get started | ||
|
||
Connect and configure these integrations: | ||
|
||
1. [**GitHub**][github] _(required)_ | ||
2. [**Slack**][slack] or [**Microsoft Teams**][msteams] _(required)_ | ||
|
||
[github]: https://go.atomist.com/catalog/integration/github "GitHub Integration" | ||
[slack]: https://go.atomist.com/catalog/integration/slack "Slack Integration" | ||
[msteams]: | ||
https://go.atomist.com/catalog/integration/microsoft-teams | ||
"Microsoft Teams Integration" | ||
|
||
We recommend installing the | ||
[GitHub Notifications](https://go.atomist.com/catalog/skills/atomist/github-notifications-skill) | ||
skill in order to receive notifications for your GitHub activity. | ||
|
||
## How to configure | ||
|
||
1. **Always invite committers** | ||
|
||
With this setting you can control if you want the skill to always invite | ||
chat users to linked channels when they push to repositories. | ||
|
||
1. **Allow committers to opt out** | ||
|
||
Some committers might not want to get invited to channels when they commit | ||
and push to repositories. GitHub logins or chat user names of such uers can | ||
be added here to prevent invitations to go out. | ||
|
||
1. **Prefix channel names** | ||
|
||
Use this setting to prefix the names of newly created channels for better | ||
grouping. | ||
|
||
By default, this skill creates channels named after the repository. Manually | ||
renamed or linked channels will not get renamed. | ||
|
||
1. **Determine repository scope** | ||
|
||
 | ||
|
||
By default, this skill will be enabled for all repositories in all | ||
organizations you have connected. | ||
|
||
To restrict the organizations or specific repositories on which the skill | ||
will run, you can explicitly choose organizations and repositories. | ||
|
||
1. **Activate the skill** | ||
|
||
 | ||
|
||
Save your configuration and activate the skill by clicking the "Enable | ||
skill" button. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters