Merge pull request #14 from lelia/deprecate-renovate-other-fixes

Deprecate Renovate and fix GitHub URL refs

.github/ISSUE_TEMPLATE/BUG_REPORT.md

@@ -11,11 +11,11 @@ assignees: ''
 
 Please provide a description of the problem.
 
-## Expected Behaviour
+## Expected Behavior
 
 Please describe what you expected would happen.
 
-## Actual Behaviour
+## Actual Behavior
 
 Please describe what happened instead.
 
@@ -32,5 +32,5 @@ Please provide the version number where this issue was encountered.
 ## Checklist
 
 <!-- TODO: Update the link below to point to your project's contributing guidelines -->
-- [ ] I have read the [contributing guidelines](https://github.com/wayfair-incubator/oss-template/blob/main/CONTRIBUTING.md)
+- [ ] I have read the [contributing guidelines](/CONTRIBUTING.md)
 - [ ] I have verified this does not duplicate an existing issue

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,8 +1,10 @@
 ## Description
 
-Please provide a meaningful description of what this change will do, or is for. Bonus points for including links to related issues, other PRs, or technical references.
+Please provide a meaningful description of what this change will do, or is for. Bonus points for including links to
+related issues, other PRs, or technical references.
 
-Note that by _not_ including a description, you are asking reviewers to do extra work to understand the context of this change, which may lead to your PR taking much longer to review, or result in it not being reviewed at all.
+Note that by _not_ including a description, you are asking reviewers to do extra work to understand the context of this
+change, which may lead to your PR taking much longer to review, or result in it not being reviewed at all.
 
 ## Type of Change
 
@@ -16,7 +18,7 @@ Note that by _not_ including a description, you are asking reviewers to do extra
 ## Checklist
 
 <!-- TODO: Update the link below to point to your project's contributing guidelines -->
-- [ ] I have read the [contributing guidelines](https://github.com/wayfair-incubator/oss-template/blob/main/CONTRIBUTING.md)
+- [ ] I have read the [contributing guidelines](/CONTRIBUTING.md)
 - [ ] Existing issues have been referenced (where applicable)
 - [ ] I have verified this change is not present in other open pull requests
 - [ ] Functionality is documented

.github/dependabot.yaml

@@ -1,7 +1,7 @@
 ---
 version: 2
 updates:
-  - package-ecosystem: 'github-actions'
-    directory: '/'
+  - package-ecosystem: "github-actions"
+    directory: "/"
     schedule:
-        interval: 'weekly'
+      interval: "weekly"

.github/workflows/lint.yml

@@ -1,27 +1,22 @@
 name: lint
 
-on: # Rebuild any PRs and main branch changes
+on:
   push:
     branches:
       - main
-      - develop
   pull_request:
 
 jobs:
   markdown:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - name: ⬇️ lint markdown files # Lints all markdown (.md) files
-        uses: avto-dev/markdown-lint@v1
+      - name: 🔒 harden runner
+        uses: step-security/harden-runner@63c24ba6bd7ba022e95695ff85de572c04a18142 # v2.7.0
         with:
-          config: '.markdownlint.json'
-          args: '**/*.md .github/**/*.md'
-  renovate:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - name: 🧼 lint renovate config # Validates changes to renovate.json config file
-        uses: suzuki-shunsuke/[email protected]
+          egress-policy: audit
+      - uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3.6.0
+      - name: ⬇️ lint markdown files
+        uses: avto-dev/markdown-lint@04d43ee9191307b50935a753da3b775ab695eceb # v1.5.0
         with:
-          config_file_path: 'renovate.json'
+          config: ".markdownlint.json"
+          args: "**/*.md .github/**/*.md"

.github/workflows/stale.yml

@@ -5,8 +5,12 @@ on:
     - cron: "0 0 * * 0"
   workflow_dispatch:
 
+permissions:
+  contents: read
+
 jobs:
   mark-stale:
+    # Call reusable workflow file
     uses: cisco-ospo/.github/.github/workflows/_stale.yml@main
     permissions:
       issues: write

CONTRIBUTING.md

@@ -4,12 +4,12 @@ Thanks for your interest in contributing to `<project name>`! Here are a few gen
 reporting bugs that we ask you to review. Following these guidelines helps to communicate that you respect the time of
 the contributors managing and developing this open source project. In return, they should reciprocate that respect in
 addressing your issue, assessing changes, and helping you finalize your pull requests. In that spirit of mutual respect,
-we endeavour to review incoming issues and pull requests within 10 days, and will close any lingering issues or pull
+we endeavor to review incoming issues and pull requests within 10 days, and will close any lingering issues or pull
 requests after 60 days of inactivity.
 
-Please note that all of your interactions in the project are subject to our [Code of Conduct](CODE_OF_CONDUCT.md). This
+Please note that all of your interactions in the project are subject to our [Code of Conduct](/CODE_OF_CONDUCT.md). This
 includes creation of issues or pull requests, commenting on issues or pull requests, and extends to all interactions in
-any real-time space (eg. Slack, Discord, etc).
+any real-time space e.g., Slack, Discord, etc.
 
 ## Reporting Issues
 
@@ -20,7 +20,7 @@ When creating a new issue, please be sure to include a **title and clear descrip
 possible, and, if possible, a test case.
 
 **If you discover a security bug, please do not report it through GitHub. Instead, please see security procedures in
-[SECURITY.md](SECURITY.md).**
+[SECURITY.md](/SECURITY.md).**
 
 ## Sending Pull Requests
 

README.md

@@ -1,7 +1,7 @@
 # Open Source Project Template
 
-[![Release](https://img.shields.io/github/v/release/wayfair-incubator/oss-template?display_name=tag)](CHANGELOG.md)
-[![Lint](https://github.com/wayfair-incubator/oss-template/actions/workflows/lint.yml/badge.svg?branch=main)](https://github.com/wayfair-incubator/oss-template/actions/workflows/lint.yml)
+[![Release](https://img.shields.io/github/v/release/cisco-ospo/oss-template?display_name=tag)](CHANGELOG.md)
+[![Lint](https://github.com/cisco-ospo/oss-template/actions/workflows/lint.yml/badge.svg?branch=main)](https://github.com/cisco-ospo/oss-template/actions/workflows/lint.yml)
 [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.0-4baaaa.svg)](CODE_OF_CONDUCT.md)
 [![Maintainer](https://img.shields.io/badge/Maintainer-Cisco-lightblue)](https://opensource.cisco.com/)
 
@@ -14,7 +14,7 @@ In trying to keep this template as generic and reusable as possible, there are s
 - [ ] ✅ Select an appropriate license for your project. This can easily be achieved through the 'Add File' button on the GitHub UI, naming the file `LICENSE`, and selecting your desired license from the provided list.
 - [ ] Update the `<License name>` placeholder in this file to reflect the name of the license you selected above.
 - [ ] Replace `[INSERT CONTACT METHOD]` in [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md) with a suitable communication channel.
-- [ ] Change references to `org_name` to the name of the org your repo belongs to (eg. `wayfair-incubator`):
+- [ ] Change references to `org_name` to the name of the org your repo belongs to (eg. `cisco-open`):
   - [ ] In [`README.md`](README.md)
   - [ ] In [`CONTRIBUTING.md`](CONTRIBUTING.md)
 - [ ] Change references to `repo_name` to the name of your new repo:
@@ -28,9 +28,7 @@ In trying to keep this template as generic and reusable as possible, there are s
   - [ ] In [`SECURITY.md`](SECURITY.md)
 - [ ] Add names and contact information for actual project maintainers to [`MAINTAINERS.md`](MAINTAINERS.md).
 - [ ] Delete the content of [`CHANGELOG.md`](CHANGELOG.md). We encourage you to [keep a changelog](https://keepachangelog.com/en/1.0.0/).
-- [ ] Configure [`renovate.json`](renovate.json) for your project's language and tooling dependencies.
-  - [ ] Note that the base `renovate.json` file included with this template inherits most of its configuration logic from Wayfair OSPO's recommended presets, hosted [here](https://github.com/wayfair/ospo-automation/blob/main/default.json). If your project does not require advanced dependency configuration, this may be sufficient for your needs.
-  - [ ] 💡 To learn more about using and configuring [Renovate](http://renovatebot.com/), check out our [wayfair.github.io](https://wayfair.github.io) article: **[Managing Project Dependencies](https://wayfair.github.io/docs/managing-dependencies/)**.
+- [ ] Configure [`.github/dependabot.yaml`](dependabot.yaml) for your project's language and tooling dependencies.
 - [ ] Replace the generic content in this file with the relevant details about your project.
 - [ ] Acknowledge that some features like [branch protection rules](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule) are only available when the repo is `public`.
 - [ ] 🚨 Delete this section of the `README`!

SECURITY.md

@@ -10,11 +10,11 @@ This document outlines security procedures and general policies for the
 ## Reporting a Bug
 
 The `<project name>` team and community take all security bugs in
-`<project name>` seriously.  Thank you for improving the security of
+`<project name>` seriously. Thank you for improving the security of
 `<project name>`. We appreciate your efforts and responsible disclosure and
 will make every effort to acknowledge your contributions.
 
-Report security bugs by emailing `OpenSource@wayfair.com`.
+Report security bugs by emailing `oss-security@cisco.com`.
 
 The lead maintainer will acknowledge your email within 48 hours, and will send a
 more detailed response within 48 hours indicating the next steps in handling