Skip to content

Commit 221073f

Browse files
jeffmendozajeffmendoza
committed
v2.0 Release
1 parent db0d40d commit 221073f

File tree

3 files changed

+103
-13
lines changed

3 files changed

+103
-13
lines changed

‎.github/workflows/release.yaml‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
on:
2+
push:
3+
tags:
4+
- '*'
5+
permissions:
6+
id-token: write # Undocumented OIDC support.
7+
packages: write # To publish container images to GHCR
8+
contents: write # To create a release
9+
jobs:
10+
release:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v2
14+
- uses: actions/setup-go@v2
15+
with:
16+
go-version: 1.17
17+
- uses: sigstore/cosign-installer@main
18+
- run: go install github.com/google/[email protected]
19+
- run: echo "${{ secrets.GITHUB_TOKEN }}" | docker login ghcr.io -u ${{ github.workflow }} --password-stdin
20+
- run: KO_DOCKER_REPO=ghcr.io/${{ github.repository_owner }} ko publish -B ./cmd/allstar > container
21+
- run: docker pull $(cat container)
22+
- run: docker tag $(cat container) ghcr.io/${{ github.repository_owner }}/allstar:${{ github.ref_name }}
23+
- run: docker push ghcr.io/${{ github.repository_owner }}/allstar:${{ github.ref_name }}
24+
- run: COSIGN_EXPERIMENTAL=1 cosign sign -a git_sha=$GITHUB_SHA ghcr.io/${{ github.repository_owner }}/allstar:${{ github.ref_name }}
25+
- run: gh release create ${{ github.ref_name }} --notes "ghcr.io/${{ github.repository_owner }}/allstar:${{ github.ref_name }}"
26+
env:
27+
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

‎README.md‎

Lines changed: 23 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,26 @@
22

33
# **Allstar**
44

5-
## Overview
5+
## Overview
66

77
- [What Is Allstar?](#what-is-allstar)
88

9+
## What's new with Allstar
10+
11+
- [whats-new.md](whats-new.md)
12+
913
## Disabling Unwanted Issues
1014

1115
- [Help! I'm getting issues created by Allstar and I don't want them!](#disabling-unwanted-issues-1)
1216

13-
## Getting Started
17+
## Getting Started
1418

15-
- [Background](#background)
16-
- [Org-Level Options](#org-level-options)
19+
- [Background](#background)
20+
- [Org-Level Options](#org-level-options)
1721
- [Installation Options](#installation-options)
1822
- [Quickstart Installation](#quickstart-installation)
1923
- [Manual Installation](#manual-installation)
20-
24+
2125
## Policies and Actions
2226
- [Actions](#actions)
2327
- [Policies](#policies)
@@ -32,21 +36,27 @@
3236
________
3337
________
3438

35-
## Overview
39+
## Overview
3640

3741
### What is Allstar?
3842

39-
Allstar is a GitHub App that continuously monitors GitHub organizations or repositories for adherence to security best practices.
40-
If Allstar detects a security policy violation, it creates an issue to alert the repository or organization owner.
41-
For some security policies, Allstar can also automatically change the project setting that caused the violation, reverting it to the expected state.
43+
Allstar is a GitHub App that continuously monitors GitHub organizations or
44+
repositories for adherence to security best practices. If Allstar detects a
45+
security policy violation, it creates an issue to alert the repository or
46+
organization owner. For some security policies, Allstar can also automatically
47+
change the project setting that caused the violation, reverting it to the
48+
expected state.
4249

43-
Allstar’s goal is to give you finely tuned control over the files and settings that affect the security of your projects.
44-
You can choose which security policies to monitor at both the organization and repository level, and how to handle policy violations.
45-
You can also develop or contribute new policies.
50+
Allstar’s goal is to give you finely tuned control over the files and settings
51+
that affect the security of your projects. You can choose which security
52+
policies to monitor at both the organization and repository level, and how to
53+
handle policy violations. You can also develop or contribute new policies.
4654

4755
Allstar is developed under the [OpenSSF](https://openssf.org/) organization, as
4856
a part of the [Securing Critical Projects Working
49-
Group](https://github.com/ossf/wg-securing-critical-projects).
57+
Group](https://github.com/ossf/wg-securing-critical-projects).
58+
59+
## [What's new with Allstar](whats-new.md)
5060

5161
## Disabling Unwanted Issues
5262
If you're getting unwanted issues created by Allstar, follow [these directions](opt-out.md) to opt out.

‎whats-new.md‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# What's new with Allstar
2+
3+
Major features and changes added to Allstar.
4+
5+
## Added since last release
6+
7+
-
8+
9+
## Release v2.0
10+
11+
- Branch Protection added the `requireStatusChecks` setting to ensure listed
12+
status checks are set in protection settings. Also enforces the
13+
`requireUpToDateBranch` option, if `requireStatusChecks` is set.
14+
15+
- You may now opt-out of repos marked as "archived" in GitHub with the
16+
`optOutArchivedRepos` option.
17+
18+
- Binary Artifacts policy issue text improved.
19+
20+
- A custom footer can be added to all issues created in an organization with
21+
the `issueFooter` option.
22+
23+
- Branch Protection now supports the "fix" action.
24+
25+
## Proposed functionality changes in v2.0
26+
27+
- Option `testingOwnerlessAllowed` in Outside Collaborator policy. Currently
28+
defaults true, proposal to default to false in next release.
29+
30+
- Note: this was temporarily enabled in Jan, but then turned off due to a bug.
31+
32+
## Pre v2.0
33+
34+
Regular releases were not made before v2.0, so all previous notes are here.
35+
36+
- All issues for an org can be routed to a single repo using the `issueRepo`
37+
setting.
38+
39+
- Org config can now be located in `.github/allstar` as a secondary location
40+
after the `.allstar` repo.
41+
42+
- Issues can be created with a custom label using the `issueLabel` option.
43+
44+
- Private or Public repositories can be opt-out as a group with the
45+
`optOutPrivateRepos` or `optOutPublicRepos` options.
46+
47+
- We will retroactively call this Allstar v1.0: Allstar announced
48+
https://openssf.org/blog/2021/08/11/introducing-the-allstar-github-app/
49+
50+
- Initial policies and features built
51+
52+
- Allstar was proposed to the OpenSSF Securing Critical Projects WG and
53+
accepted https://youtu.be/o3SiBDUTCrw?t=300

0 commit comments

Comments
 (0)