Danger runs after your CI, automating your team's conventions surrounding code review.
This provides another logical step in your process, through which Danger can help lint your rote tasks in daily code
review.
You can use Danger to codify your team's norms, leaving humans to think about harder problems.
Danger JS works with GitHub, BitBucket Server, BitBucket Cloud for code review, then with: Travis CI, GitLab CI,
Semaphore, Circle CI, GitHub Actions, Jenkins, Bamboo, Bitrise, surf-build, Codeship, Drone, Buildkite, Buddy.works,
TeamCity, Visual Studio Team Services, Screwdriver, Concourse, Netlify, CodeBuild, Codefresh, AppCenter, BitBucket
Pipelines, Cirrus CI, Codemagic or Xcode Cloud.
For example?
You can:
Enforce CHANGELOGs
Enforce links to Trello/JIRA in PR/MR bodies
Enforce using descriptive labels
Look out for common anti-patterns
Highlight interesting build artifacts
Give warnings when specific files change
Danger provides the glue to let you build out the rules specific to your team's culture, offering useful metadata and
a comprehensive plugin system to share common issues.
Getting Started
Alright. So, actually, you may be in the wrong place. From here on in, this README is going to be for people who are
interested in working on and improving on Danger JS.
Check the issues, I try and keep my short term perspective there. Long term is in the VISION.md.
Releasing a new version of Danger
Releases are triggered by pushing a version tag. Tag creation on this repo is restricted by the "Release tags"
repository ruleset, so the set of people who can ship a release is that ruleset's bypass list.
Checkout the main branch. Ensure your working tree is clean, and make sure you have the latest changes by running
git pull; yarn.
Bump and tag - npm run release -- patch --ci. This bumps package.json, commits, tags and pushes. It no longer publishes
to npm from your machine, so there's no OTP to enter.
Pushing the tag runs npm_publish.yml, which publishes to npm using npm's
trusted publishing (there is no NPM_TOKEN secret) and then kicks off release.yml for the macOS native builds and
the homebrew tap.
The publish job runs in the npm-release environment, which only tags can deploy to. Combined with the tag ruleset,
that means a branch can never obtain npm's OIDC credentials. Changes to anything under .github/workflows/ need a
review from an admin, via CODEOWNERS.
:ship:
License, Contributor's Guidelines and Code of Conduct
We try to keep as much discussion as possible in GitHub issues, but also have a pretty inactive Slack --- if you'd like
an invite, ping @Orta a DM on Twitter with your email. It's mostly interesting if you want
to stay on top of Danger without all the emails from GitHub.
This project is open source under the MIT license, which means you have full access to the source code and can modify
it to fit your own needs but don't have access to deploy.
This project subscribes to the Moya Contributors Guidelines which TLDR: means
we give out push access easily and often.