Skip to content

Commit 6d583bd

Browse files
authored
Cleanup Repository files and Gem build (#536)
This PR updates this repository to remove extraneous files, update the README.md, and remove files from the Gem build. Closes #531
1 parent 5866810 commit 6d583bd

File tree

4 files changed

+15
-6
lines changed

4 files changed

+15
-6
lines changed

.ruby-gemset

Lines changed: 0 additions & 1 deletion
This file was deleted.

.ruby-version

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
3.1.1
1+
3.1.6

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Secure Headers ![Build + Test](https://github.com/github/secure_headers/workflows/Build%20+%20Test/badge.svg?branch=main)
22

3-
**main branch represents 6.x line**. See the [upgrading to 4.x doc](docs/upgrading-to-4-0.md), [upgrading to 5.x doc](docs/upgrading-to-5-0.md), or [upgrading to 6.x doc](docs/upgrading-to-6-0.md) for instructions on how to upgrade. Bug fixes should go in the 5.x branch for now.
3+
**main branch represents 7.x line**. See the [upgrading to 4.x doc](docs/upgrading-to-4-0.md), [upgrading to 5.x doc](docs/upgrading-to-5-0.md), [upgrading to 6.x doc](docs/upgrading-to-6-0.md) or [upgrading to 7.x doc](docs/upgrading-to-7-0.md) for instructions on how to upgrade. Bug fixes should go in the `6.x` branch for now.
44

55
The gem will automatically apply several headers that are related to security. This includes:
66
- Content Security Policy (CSP) - Helps detect/prevent XSS, mixed-content, and other classes of attack. [CSP 2 Specification](https://www.w3.org/TR/CSP2/)

secure_headers.gemspec

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,20 @@ Gem::Specification.new do |gem|
1414
including content-security-policy, x-frame-options,
1515
strict-transport-security, etc.'
1616
gem.homepage = "https://github.com/github/secure_headers"
17+
gem.metadata = {
18+
"bug_tracker_uri" => "https://github.com/github/secure_headers/issues",
19+
"changelog_uri" => "https://github.com/github/secure_headers/blob/master/CHANGELOG.md",
20+
"documentation_uri" => "https://rubydoc.info/gems/secure_headers",
21+
"homepage_uri" => gem.homepage,
22+
"source_code_uri" => "https://github.com/github/secure_headers",
23+
"rubygems_mfa_required" => "true",
24+
}
1725
gem.license = "MIT"
18-
gem.files = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
19-
gem.executables = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
20-
gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
26+
27+
gem.files = Dir["bin/**/*", "lib/**/*", "README.md", "CHANGELOG.md", "LICENSE", "Gemfile", "secure_headers.gemspec"]
2128
gem.require_paths = ["lib"]
29+
30+
gem.extra_rdoc_files = Dir["README.md", "CHANGELOG.md", "LICENSE"]
31+
2232
gem.add_development_dependency "rake"
2333
end

0 commit comments

Comments
 (0)