Skip to content

chore: Add security issue notification to readme #137

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

Merged
merged 4 commits into from
Oct 5, 2020

Conversation

seebees
Copy link
Contributor

@seebees seebees commented Jun 5, 2020

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

Check any applicable:

  • Were any files moved? Moving files changes their URL, which breaks all hyperlinks to the files.

mattsb42-aws
mattsb42-aws previously approved these changes Jun 5, 2020
acioc
acioc previously approved these changes Jul 9, 2020
@lizroth
Copy link
Contributor

lizroth commented Oct 1, 2020

Now that the checks are running again, this caught an actual issue

(line 42) broken https://github.com/aws/aws-dynamodb-encryption-python/tree/master/CONTRIBUTING.md#security-issue-notifications - Anchor 'security-issue-notifications' not found

Looking into options to fix this up in this PR if possible

Edit: I take it back. I thought there must be a typo or something, but the anchor does appear to exist/work. False negative?

Sphinx linkcheck seems to error if the anchor doesn't exactly match the id= value, even if the anchor itself works.
@lizroth lizroth dismissed stale reviews from acioc and mattsb42-aws via e7ac037 October 1, 2020 21:38
@lizroth
Copy link
Contributor

lizroth commented Oct 1, 2020

The #security-issue-notifications anchor works, but the actual a id= value is <a id="user-content-security-issue-notifications". Sphinx's linkcheck is looking at the id value directly, I suppose, so the check was showing up as broken. Using the real/raw ID value seems to do the trick in my local testing.

@lizroth lizroth merged commit 578774f into master Oct 5, 2020
@texastony texastony deleted the security-issue-notification branch July 21, 2021 18:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants