Skip to content

Commit dede900

Browse files
authored
Merge pull request #807 from ascopes/task/security-docs
Include GH contributing guide and security notes in generated site
2 parents ce43d0a + 1725bb6 commit dede900

4 files changed

Lines changed: 6 additions & 4 deletions

File tree

CONTRIBUTING.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ Make sure you provide full details of what you are trying to do and why. Include
1818
what you expect to happen, versus what actually happens. Run `mvn` or `mvnw` in your project
1919
with the `--errors` flag to get full exception stacktraces.
2020

21-
> [!IMPORTANT]
2221
> If possible and appropriate, try to show `protoc` being called directly and producing the output you
2322
> expect.
2423
@@ -87,7 +86,6 @@ This project uses semantic versioning!
8786
If you need to add a new user-facing feature (i.e. something that is accessible via the interface used in
8887
a `pom.xml` when using this plugin), you should bump the minor version of this plugin.
8988

90-
> [!NOTE]
9189
> If you are making a breaking API change, you need to bump the major version.
9290
9391
I'll advise about this during PR reviews as needed, but you can use the `scripts/bump-versions.sh` script
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../../../CONTRIBUTING.md
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../../../SECURITY.md

protobuf-maven-plugin/src/site/site.xml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,6 @@
5656
<menu name="Documentation">
5757
<item name="Introduction" href="index.html"/>
5858
<item name="Goals" href="plugin-info.html"/>
59-
<item name="Requirements" href="requirements.html"/>
60-
<item name="Known Issues" href="known-issues.html"/>
6159
</menu>
6260
<menu name="Guides">
6361
<item name="Basic Usage" href="basic-usage.html"/>
@@ -67,14 +65,18 @@
6765
<item name="Descriptor Files" href="descriptor-files.html"/>
6866
<item name="Examples" href="examples.html"/>
6967
<item name="Faster Builds" href="faster-builds.html"/>
68+
<item name="Known Issues" href="known-issues.html"/>
7069
<item name="Other Language Support" href="other-language-support.html"/>
70+
<item name="Requirements" href="requirements.html"/>
7171
<item name="Using Protoc Plugins" href="using-protoc-plugins.html"/>
7272
</menu>
7373
<menu name="Releases">
7474
<item name="GitHub" href="https://github.com/ascopes/protobuf-maven-plugin/releases"/>
7575
<item name="Maven Central" href="https://central.sonatype.com/artifact/io.github.ascopes/protobuf-maven-plugin"/>
7676
</menu>
7777
<menu name="Development">
78+
<item name="Contributing Guide" href="gh-contributing.html"/>
79+
<item name="Security Policy" href="gh-security.html"/>
7880
<item name="Issues and Bugs" href="https://github.com/ascopes/protobuf-maven-plugin/issues"/>
7981
<item name="Discussions" href="https://github.com/ascopes/protobuf-maven-plugin/discussions"/>
8082
<item name="Source Code" href="https://github.com/ascopes/protobuf-maven-plugin"/>

0 commit comments

Comments
 (0)