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

Merge Dev into Main #170

Merged
merged 82 commits into from
Oct 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
82 commits
Select commit Hold shift + click to select a range
2bdd526
added required fields to code.json and cookiecutter
natalialuzuriaga Sep 6, 2024
e67cc33
my first commit
jabirG Sep 16, 2024
a50f756
first commit down to the first table
jabirG Sep 16, 2024
978d21a
Finished checklist without table of contents first initial rough draft
jabirG Sep 19, 2024
75e86bb
translated checklist to markdown
jabirG Sep 19, 2024
c91cf49
fixed a typo within the README
sachin-panayil Sep 23, 2024
be40f21
Merge pull request #151 from DSACMS/spanayil/typoFix
IsaacMilarky Sep 23, 2024
20d0df2
Updated code.json cookiecutter to populate all required fields. Code.…
natalialuzuriaga Sep 23, 2024
01a8121
Update order of the cookiecutter prompts and changed repoType field n…
natalialuzuriaga Sep 24, 2024
eca86d6
Merge pull request #148 from DSACMS/nat/req-fields-code-json
IsaacMilarky Sep 24, 2024
3863bee
fixed typos and grammatically errors
jabirG Sep 25, 2024
fcff751
Minor Tweaks
jabirG Sep 26, 2024
79960a4
Final Changes
jabirG Sep 26, 2024
b469685
Completed Markdown Checklist
jabirG Sep 26, 2024
7812259
Merge pull request #150 from DSACMS/amazing-markdown-translation
jabirG Sep 26, 2024
ac77bb5
added dateCreated functionality to code.json for tier1
sachin-panayil Sep 26, 2024
f7ed56a
Merge branch 'nat/req-fields-code-json' of github.com:DSACMS/repo-sca…
sachin-panayil Sep 26, 2024
d4a2f2f
added exception handling and changed field name
sachin-panayil Sep 27, 2024
89a095e
Added a README.md to Tier 1
natalialuzuriaga Oct 1, 2024
bd2cf6a
Added link to maturity-model-tiers.md in tier 1 README.md
natalialuzuriaga Oct 1, 2024
d7de9ae
Added tier 2 README.md
natalialuzuriaga Oct 1, 2024
77c7227
Added README.md for tier 3
natalialuzuriaga Oct 1, 2024
1c30b74
Added README.md to Tier 4
natalialuzuriaga Oct 1, 2024
a6a8368
Revised one-liner on files of project for all tiers
natalialuzuriaga Oct 1, 2024
d17a1cf
Added some revisions
natalialuzuriaga Oct 1, 2024
36c5550
Added some revisions
natalialuzuriaga Oct 1, 2024
1c45e87
Merge pull request #154 from DSACMS/nat/tier-docs
natalialuzuriaga Oct 1, 2024
040b8de
Update instructions on creating code.json + fixed typos
natalialuzuriaga Oct 1, 2024
36b96cf
Merge pull request #155 from DSACMS/nat/tier-docs
natalialuzuriaga Oct 1, 2024
cc8c5cc
Added code.json cookiecutter files to tier 2
natalialuzuriaga Oct 1, 2024
827748f
Added code.json cookiecutter files to tier3
natalialuzuriaga Oct 1, 2024
8b0e496
Added code.json cookiecutter files to tier 4
natalialuzuriaga Oct 1, 2024
ea2e481
Changed repometrics directory to codejson in tier 3
natalialuzuriaga Oct 1, 2024
65bbc94
Changed repometrics directory to codejson in tier 2
natalialuzuriaga Oct 1, 2024
7af7257
Changed repometrics directory to codejson in tier 4
natalialuzuriaga Oct 1, 2024
6d55968
Updated instructions to reflect correct flag value for directory
natalialuzuriaga Oct 1, 2024
28ed090
hanged repometrics directory to codejson in tier 1
natalialuzuriaga Oct 1, 2024
7303a18
Merge pull request #156 from DSACMS/nat/code-json-tiers
natalialuzuriaga Oct 1, 2024
456ee4d
pending maintainers
IsaacMilarky Oct 1, 2024
369c58c
adding python and deleting the bash script
IsaacMilarky Oct 1, 2024
d1a4e74
add labor hours scc calc to post_gen_hook
IsaacMilarky Oct 1, 2024
a798ba5
comment and remove bash script
IsaacMilarky Oct 1, 2024
ff80d35
key error
IsaacMilarky Oct 1, 2024
eee0eed
merge with dev
IsaacMilarky Oct 1, 2024
bfcf0be
Create pull_request_template.md
natalialuzuriaga Oct 1, 2024
b0fbeee
requested changes
IsaacMilarky Oct 1, 2024
672c40b
Merge branch 'isaac/releases-docs' of github.com:DSACMS/repo-scaffold…
IsaacMilarky Oct 2, 2024
8430fb4
Create release guidance for tier 1 repositories
IsaacMilarky Oct 2, 2024
9d0ad32
Create release guidance for tier 3 repositories
IsaacMilarky Oct 2, 2024
5845b3f
Create release guidance for tier 4 repositories
IsaacMilarky Oct 2, 2024
c814497
Create release guidance for tier 4 repositories
IsaacMilarky Oct 2, 2024
66fec4e
links
IsaacMilarky Oct 2, 2024
f8c2e0c
fix links
IsaacMilarky Oct 2, 2024
bfaa66b
Merge pull request #159 from DSACMS/natalialuzuriaga-patch-3
IsaacMilarky Oct 2, 2024
b0a4f36
Merge branch 'dev' into isaac/releases-docs
IsaacMilarky Oct 2, 2024
93c7de2
Merge branch 'dev' into labor-hours-redux
IsaacMilarky Oct 2, 2024
bae3f20
remove labor hours prompt from cookiecutter script
IsaacMilarky Oct 2, 2024
a06035e
rename mentions of repometrics
IsaacMilarky Oct 2, 2024
38320a4
add laborHours back as a private variable
IsaacMilarky Oct 2, 2024
ebf0599
syntax
IsaacMilarky Oct 2, 2024
34adcc4
re-add to other tiers
IsaacMilarky Oct 2, 2024
83eee62
Merge pull request #157 from DSACMS/labor-hours-redux
IsaacMilarky Oct 2, 2024
e208a92
added correct script to rest of tiers
sachin-panayil Oct 2, 2024
5fb52a1
Converted Tier 3 checklist into a markdown document
NoobNoob06 Oct 2, 2024
c1642dd
Fixed links in table of content for Tracking and Communiications & Ro…
NoobNoob06 Oct 2, 2024
5a80439
Fixed typos, adjusted structure for readability
NoobNoob06 Oct 2, 2024
1e73192
Fixed link to 'OWASP's current 10 Most Critical Web Application
NoobNoob06 Oct 3, 2024
890aa55
Moved location of pull request template
natalialuzuriaga Oct 3, 2024
1cb7f62
Add issue templates
natalialuzuriaga Oct 3, 2024
5491e12
Create checks.yml
natalialuzuriaga Oct 3, 2024
9195325
Removed raw tags
natalialuzuriaga Oct 3, 2024
59df51d
added blank date field to json
sachin-panayil Oct 4, 2024
dfcaaab
Merge pull request #165 from DSACMS/sachin/adding-script-to-tiers
IsaacMilarky Oct 4, 2024
91e1441
rename release guidelines template
IsaacMilarky Oct 4, 2024
a30dc20
Merge pull request #160 from DSACMS/isaac/releases-docs
IsaacMilarky Oct 4, 2024
d5423fa
Updated Markdown to according to feedback
NoobNoob06 Oct 4, 2024
ed10fbf
Merge pull request #168 from DSACMS/natalialuzuriaga-patch-4
IsaacMilarky Oct 4, 2024
c43a034
Updated 'Security.md' link, and typo
NoobNoob06 Oct 4, 2024
ccf6f62
Merge pull request #169 from DSACMS/natalialuzuriaga-patch-5
natalialuzuriaga Oct 4, 2024
7445dcb
Merge pull request #167 from DSACMS/nat/templates
natalialuzuriaga Oct 4, 2024
0935d2e
merge with dev
IsaacMilarky Oct 4, 2024
8a7b096
Merge pull request #166 from DSACMS/tier3-checklist-markdown
IsaacMilarky Oct 4, 2024
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
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]

**Additional context**
Add any other context about the problem here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
42 changes: 42 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
<!--
Thank you for sending the PR! We appreciate you spending the time to work on
these changes.
Help us understand your motivation by explaining why you decided to make this change.
Happy contributing!
- Comments should be formatted to a width no greater than 80 columns.
- Files should be exempt of trailing spaces.
- We adhere to a specific format for commit messages. Please write your commit
messages along these guidelines. Please keep the line width no greater than 80
columns (You can use `fmt -n -p -w 80` to accomplish this).
-->

## module-name: One line description of your change (less than 72 characters)

## Problem

Explain the context and why you're making that change. What is the problem
you're trying to solve? In some cases there is not a problem and this can be
thought of being the motivation for your change.

## Solution

Describe the modifications you've done.

## Result

What will change as a result of your pull request? Note that sometimes this
section is unnecessary because it is self-explanatory based on the solution.

Some important notes regarding the summary line:

* Describe what was done; not the result
* Use the active voice
* Use the present tense
* Capitalize properly
* Do not end in a period — this is a title/subject
* Prefix the subject with its scope

## Test Plan

(Write your test plan here. If you changed any code, please provide us with
clear instructions on how you verified your changes work.)
55 changes: 55 additions & 0 deletions .github/workflows/checks.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
name: "run-linting-checks"
on:
push:
branches:
- 'main'

jobs:
resolve-repolinter-json:
uses: DSACMS/repo-scaffolder/.github/workflows/extendJSONFile.yml@main
with:
url_to_json: 'https://raw.githubusercontent.com/DSACMS/repo-scaffolder/main/tier3/%7B%7Bcookiecutter.project_slug%7D%7D/repolinter.json'

repolinter-checks:
name: Tier 3 Checks
needs: resolve-repolinter-json
runs-on: ubuntu-latest
env:
RAW_JSON: ${{ needs.resolve-repolinter-json.outputs.raw-json }}
steps:
- uses: actions/checkout@v4
- run: echo $RAW_JSON > repolinter.json
- uses: newrelic/repolinter-action@v1
with:
# A path to the JSON/YAML Repolinter ruleset to use, relative to the workflow
# working directory (i.e. under `$GITHUB_WORKSPACE`).
#
# This option is mutually exclusive with config_url. If this option and
# config_url are not specified, Repolinter's default ruleset will be used.
config_file: 'repolinter.json'

# Where repolinter-action should put the linting results. There are two
# options available:
# * "exit-code": repolinter-action will print the lint output to the console
# and set the exit code to result.passed. This output type is most useful for
# PR status checks.
# * "issue": repolinter-action will create a GitHub issue on the current
# repository with the repolinter output and always exit 0. See the README for
# more details on issue outputting behavior. This output type is ideal for
# non-intrusive notification.
#
# Default: "exit-code"
output_type: 'issue'

# The title to use for the issue created by repolinter-action. This title
# should indicate the purpose of the issue, as well as that it was created by
# a bot.
#
# This option will be ignored if output_type != "issue".
#
# Default: "[Repolinter] Open Source Policy Issues"
output_name: '[Repolinter] Tier 3 Repository Hygiene Issue'

# The default token is the repolinter token for the DSACMS org
# You can change it if needed.
token: ${{ secrets.REPOLINTER_AUTO_TOKEN }}
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ If you know what tier you need, you can run the cookiecutter for an individual t
cookiecutter https://github.com/DSACMS/repo-scaffolder --directory=tierX
```

## Add Repometrics to your Project
To integrate repometrics into your new project, navigate to your project's `.github` directory and run the following cookiecutter command:
## Add code.json to your project
To add code.json into your project, navigate to your project's `.github` directory and run the following cookiecutter command. You will be asked questions about the project (see cookiecutter.json) in order to collect and store this metadata in code.json.
```
cookiecutter . --directory=repometrics
cookiecutter . --directory=codejson
```

## Existing Projects
Expand All @@ -37,15 +37,15 @@ You can update existing projects with the repo scaffolder. Using the `-s` flag
When creating projects, if you want to receive updates then add `dsacms-tierX` as a github topic to the repo. The scaffolder repo includes github workflows that will find all repos with that tag and can raise a pull request with an updated string or adding a file. See [actions.md](https://github.com/DSACMS/repo-scaffolder/blob/main/.github/actions.md) for more information.

## Editing or Adding Tiers
At a top level, each tier consisters of a folder for `hooks`, a folder containing the files to be added (`{{cookiecutter.project_slug}}`), and a `cookiecutter.json` defining the questions cookiecutter asks. These naming conventions must be
At a top level, each tier consists of a folder for `hooks`, a folder containing the files to be added (`{{cookiecutter.project_slug}}`), and a `cookiecutter.json` defining the questions cookiecutter asks. These naming conventions must be
followed as that is what cookiecutter picks up. The `hooks` folder needs to be duplicated in each tier. The folder
containing the files to be added can include slugged out variables such as `{{ cookiecutter.project_name }}` that can
be filled in by the answers to `cookiecutter.json`. For example, `{{ cookiecutter.project_name }}` will be filled in by
this question - `"project_name": "My Project",`. See the [cookiecutter docs](https://cookiecutter.readthedocs.io/en/stable/)
for more information.

## Repolinter
Tiers of level 1 thru 4 have repolinter.json file in their projects. Tier1 has detailed configuration of all the rules. All the other tiers extends their previuos tiers and has only the `rule` and the `level` configuration.
Tiers of level 1 thru 4 have repolinter.json file in their projects. Tier1 has detailed configuration of all the rules. All the other tiers extends their previous tiers and has only the `rule` and the `level` configuration.

Sample commands to run with the given repolinter.json path:

Expand Down Expand Up @@ -97,3 +97,4 @@ dedication](https://creativecommons.org/publicdomain/zero/1.0/) as indicated in
All contributions to this project will be released under the CC0 dedication. By
submitting a pull request or issue, you are agreeing to comply with this waiver
of copyright interest.

Binary file added assets/repolinter-results.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading