Skip to content

itisopen/github-action-validate-codeowners

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Project Banner

Test StatusLatest ReleaseSlack Community

This is a Github Action to validate the CODEOWNERS file by running a series of checks against the CODEOWNERS file to ensure that it's valid and well-linted.

Ensuring your repository's CODEOWNERS file is valid can be critical to the development process if, for instance, your project uses branch protection conditions that rely on definitions in CODEOWNERS.

Usage

Copy the .github/workflows/validate-codeowners.yml file from this repository into the .github/workflows folder of the repository to which you'd like to add Validate CODEOWNERS functionality, and ensure that you are using an appropriate token in the workflow file. This will cause the validation functionality to execute whenever any event occurs on any pull request.

Quick Start

Here's how to get started...

  1. Copy the .github/workflows/validate-codeowners.yml file from this repository into the .github/workflows folder of the repository to which you'd like to add Validate CODEOWNERS functionality.
  2. Replace ${{ secrets.CODEOWNERS_VALIDATOR_TOKEN_PUBLIC }} with the name of a token whose permissions are in line with your target repo's requirements, according to the instructions here.
  3. (Optional) Update the main pin inside validate-codeowners.yml to a fixed version. Consult https://github.com/itisopen/github-action-validate-codeowners/releases for a list of available versions.

Examples

Here's a real world example:

Related Projects

Check out these related projects.

References

For additional context, refer to some of these links.

✨ Contributing

This project is under active development, and we encourage contributions from our community.

  • Many thanks to the outstanding contributors to the Cloud Posse upstream contents. We appreciate your hard work and dedication to building scalable enterprise grade solutions.
  • Many thanks also to the contributors to the ITisOpen upstream contents. We appreciate your hard work and dedication to extending the work of Cloud Posse to other cloud providers.

For 🐛 bug reports & feature requests, please use the issue tracker.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

  1. Review our Code of Conduct and Contributor Guidelines.
  2. Fork the repo on GitHub
  3. Clone the project to your own machine
  4. Commit changes to your own branch
  5. Push your work back up to your fork
  6. Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

🌎 Slack Community

Join our Open Source Community on Slack. It's FREE for everyone! Our "ITisOpen" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally open infrastructure.

Note: ITisOpen is leverages open-source projects from Cloud Posse. We encourage you to also join the Cloud Posse Slack community for even more collaboration and support: slack.cloudposse.com

📰 Newsletter

Sign up for our newsletter and join other DevOps & Platform Engineers, CTOs, and founders who get insider access to the latest DevOps & Platform Engineering trends, so you can always stay in the know. Dropped straight into your Inbox every week — and usually a 5-minute read.

License

License

Preamble to the Apache License, Version 2.0

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.

Trademarks

All other trademarks referenced herein are the property of their respective owners.

Copyrights

  • Copyright © 2022-2025 Cloud Posse, LLC, all rights reserved for upstream content
  • Copyright © 2025-2025 ITisOpen, all rights reserved for repository-specific content

README footer

Beacon

About

GitHub Action to Validate CODEOWNERS

Resources

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages

  • Makefile 100.0%