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 issues to resolve all open CodeQL alerts #5159

Open
18 of 36 tasks
Tracked by #5005
roslynwythe opened this issue Aug 7, 2023 · 2 comments
Open
18 of 36 tasks
Tracked by #5005

Create issues to resolve all open CodeQL alerts #5159

roslynwythe opened this issue Aug 7, 2023 · 2 comments
Labels
Complexity: Medium Complexity: See issue making label See the Issue Making label to understand the issue writing difficulty level Dependency An issue is blocking the completion or starting of another issue epic Feature: Code Alerts Issue Making: Level 1 Make issues from a template and a spreadsheet manual dependency release ready for dev lead Issues that tech leads or merge team members need to follow up on role: front end Tasks for front end developers size: 1pt Can be done in 4-6 hours
Milestone

Comments

@roslynwythe
Copy link
Member

roslynwythe commented Aug 7, 2023

Overview

Create issues to resolve open CodeQL alerts

Issues to create (this issue should remain open until these are closed)

Currently as of 4/7/2024 alerts exist up to 107. Alerts not listed above are in Pull Requests.

Action Items

  • Create an issue for each CodeQL alert listed above that does have an issue already
    • Replace every instance of [INSERT-ALERTID] with the alert number, for example 94
    • Provide testing instructions to the developer
    • Replace the text above with a link to the new issue
  • Then move this issue to the "Ice Box" with a Dependency label. It can be closed when all the child issues are closed.

Template

### Prerequisite
1. Be a member of Hack for LA. (There are no fees to join.) If you have not joined yet, please follow the steps on our [Getting Started page](https://www.hackforla.org/getting-started).
2. Before you claim or start working on an issue, please make sure you have read our [How to Contribute to Hack for LA Guide](https://github.com/hackforla/website/blob/7f0c132c96f71230b8935759e1f8711ccb340c0f/CONTRIBUTING.md).

### Overview
As developers. we need to analyze [CodeQL query alert INSERT-ALERTID](https://github.com/hackforla/website/security/code-scanning/INSERT-ALERTID) and to either recommend dismissal of the alert or update the code to resolve the alert.    

### Action Items
- [ ] DO NOT DISMISS ANY ALERTS.  Dismissal of alerts should be done by dev leads only after review of the recommendation
- [ ] Browse to the link in the next Action Item and read the contents.  Click "See More" to view Recommendations, Examples and References.  
- [ ] https://github.com/hackforla/website/security/code-scanning/INSERT-ALERTID 
- [ ] Note these resources: 
   - [ ] See the wiki page "How to manage CodeQL alerts" (see under Resources)
   - [ ] To look at the resolution of similar alerts, visit the [code scanning page](https://github.com/hackforla/website/security/code-scanning) and query closed alerts for similar alert type.  To see the resolution of a closed alert, view the alert details and open the tracking issue (outlined in red in the screenshot under Resources)
- [ ] In a comment in this issue, provide your recommendation.  The recommendation can be one of the following: `dismiss as test`, `dismiss as false positive`, `dismiss as won't fix`, or `update code`.  An example of a 'false positive' is a report of a JavaScript syntax error that is caused by markdown or liquid symbols such as `---` or `{%`.  
- [ ] If the recommendation is to update code:
   - [ ] create an issue branch and proceed with the code update
   - [ ] Use docker to test locally, ensuring that there are no changes to the appearance or the behavior of any affected webpage(s) or GitHub actions.  If you are not certain how to test a particular code change, ask a merge team member or dev lead.  
   - [ ] proceed with pull request in the usual manner 
- [ ] If the recommendation is to dismiss, describe your reason for dismissal in the comment, then move the issue to `Questions/In Review` and apply the label `ready for dev lead`.  


### For merge team/dev lead
- [ ] If recommendation to dismiss is approved, dismiss the alert with a comment, then close the issue as completed.
- [ ] When this issue is closed please check off the dependency (under "Issues") in #5159.  If all issues are closed, close #5159 as completed.  
  
### Resources/Instructions

- [GitHub CodeQL documentation](https://codeql.github.com/docs/codeql-overview/about-codeql/)
- [code scanning page](https://github.com/hackforla/website/security/code-scanning)
- Wiki page "How to resolve CodeQL alerts" (if this page has not been published yet, see the draft at https://github.com/hackforla/website/issues/6463#issuecomment-2002573270)
- This issue is part of #5159

Resources/Instructions

@roslynwythe roslynwythe added role: front end Tasks for front end developers Complexity: Medium size: 1pt Can be done in 4-6 hours Draft Issue is still in the process of being created Feature: Code Alerts labels Aug 7, 2023
@wanyuguan wanyuguan added this to the 02. Security milestone Aug 12, 2023
@ExperimentsInHonesty
Copy link
Member

I have added the following note to the agenda for 2024-03-04
BW: CodeQL issue making review

If most of the issues already made are medium, it looks like there are 57 medium issues we could make from the HfLA website: CodeQL scan alerts (issue #5060) spreadsheet. Is that correct?
If we clear up how to manage #5005 , we could remove RW from it, correct?

@roslynwythe roslynwythe changed the title Create Code Fix Issues from CodeQL alert analysis Create issue template for resolving CodeQL alerts Mar 11, 2024
@roslynwythe roslynwythe changed the title Create issue template for resolving CodeQL alerts Create issues to resolve all open CodeQL alerts Mar 14, 2024
@roslynwythe
Copy link
Member Author

roslynwythe commented Mar 14, 2024

I have added the following note to the agenda for 2024-03-04 BW: CodeQL issue making review

If most of the issues already made are medium, it looks like there are 57 medium issues we could make from the HfLA website: CodeQL scan alerts (issue #5060) spreadsheet. Is that correct? If we clear up how to manage #5005 , we could remove RW from it, correct?

@roslynwythe roslynwythe added Issue Making: Level 1 Make issues from a template and a spreadsheet Complexity: See issue making label See the Issue Making label to understand the issue writing difficulty level Draft Issue is still in the process of being created ready for product Ready for Prioritization and removed Draft Issue is still in the process of being created ready for product labels Mar 15, 2024
@ExperimentsInHonesty ExperimentsInHonesty added ready for dev lead Issues that tech leads or merge team members need to follow up on Dependency An issue is blocking the completion or starting of another issue epic and removed Ready for Prioritization labels Mar 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Complexity: Medium Complexity: See issue making label See the Issue Making label to understand the issue writing difficulty level Dependency An issue is blocking the completion or starting of another issue epic Feature: Code Alerts Issue Making: Level 1 Make issues from a template and a spreadsheet manual dependency release ready for dev lead Issues that tech leads or merge team members need to follow up on role: front end Tasks for front end developers size: 1pt Can be done in 4-6 hours
Projects
Development

No branches or pull requests

3 participants