Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create SECURITY.md #2002

Merged
merged 3 commits into from
Jun 17, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 1 addition & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,11 +106,7 @@ Issues and PRs are split into two levels of labels, at the higher level:

## Security

For security inquiries or vulnerability reports, please email
<[email protected]>.
If you'd like, you can use our [PGP key] when reporting vulnerabilities.

[PGP key]: https://thoughtbot.com/thoughtbot.asc
See the [security policy](./SECURITY.md).

## Releasing

Expand Down
14 changes: 14 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Security Policy

## Supported Versions

Only the the latest version of Administrate is supported at a given time. If you find
Copy link

@ruanltbg ruanltbg Feb 21, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

there is a double the here.
cc @pablobm

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PRs welcome :-)

a security issue with an older version, please try updating to the latest version first.

If for some reason you can't update to the latest version, please let us know your reasons
so that we can have a better understanding of your situation.

## Reporting a Vulnerability

For security inquiries or vulnerability reports, please email [email protected].
If you'd like, you can use our PGP key when reporting vulnerabilities.
2 changes: 2 additions & 0 deletions spec/example_app/app/controllers/docs_controller.rb
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ def show
render_page("CONTRIBUTING", "Contributing Guide")
when "license", "LICENSE"
render_page("LICENSE", "LICENSE")
when "security", "SECURITY"
render_page("SECURITY", "Security Policy")
else
render_page("docs/#{params[:page]}")
end
Expand Down
12 changes: 12 additions & 0 deletions spec/features/documentation_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,18 @@
expect(page).to have_content("The MIT License (MIT)")
end

it "shows the Security Policy in both forms" do
visit("/security")

expect(page).to have_css("div.main h1", text: "Security Policy")
expect(page).to have_content("security inquiries")

visit("/SECURITY.md")

expect(page).to have_css("div.main h1", text: "Security Policy")
expect(page).to have_content("security inquiries")
end

it "shows other docs pages" do
visit("/getting_started")

Expand Down