github-action-auto-format

GitHub Action Auto-Format

Github Action Auto-Format runs several repository "hygiene" tasks for repositories:

The readme target will rebuild README.md from README.yaml.
The github_format target adds all of Cloud Posse's standard repository housekeeping files (including GitHub Actions workflows) to the repository's .github folder.
The terraform_format target ensures consistent formatting across all Terraform files in the repository.

This project is part of our comprehensive "SweetOps" approach towards DevOps.

It's 100% Open Source and licensed under the APACHE2.

Usage

If you haven't already, follow the steps in the quickstart section. To choose which pieces of functionality will be executed, modify the script-names: input to the cloudposse/github-action-auto-format step to be a comma-separated list of one or more targets (e.g., script-names: readme,terraform_format,github_format). This is an exhaustive list of all valid script-names:

readme
github_format
terraform_format If you're using the auto-format.yml workflow file distributed within this repository, then the Auto-format GitHub Action will trigger on pull request events, once a day at 7am UTC, and upon manual triggering via the workflow_dispatch mechanism.

Quick Start

Here's how to get started...

Copy .github/workflows/auto-format.yml to the corresponding folder in your target repo.
Generate a Personal Access Token (PAT) that with the workflow permission using a GitHub account that has write permissions in the target repo by following the directions here and selecting the workflow tick box on the token creation screen.
Add this token as a GitHub secret in your target repository and set the workflow-token input of the github-action-auto-format step to the name of your secret.
Set the bot-name input of the github-action-auto-format step to the GitHub username of the user who generated the token in step 2. *This user must have write permissions in the target repo.`
By default, the Auto-Format GitHub Action will execute all of its scripts when run. If you'd like to use a subset of the full functionality, modify the script-names input of the github-action-auto-format step as described in the usage section.
(Optional) You may want to change when the scheduled cron trigger is executed. If you'd like a guide, here's a useful resource for help in crafting cron strings - https://crontab.guru/
(Optional) CloudPosse recommends pinning to specific versions of actions for ease of long-term maintenance. If you care to edit the pin in auto-format.yml from main to a specific version, feel free to consult https://github.com/cloudposse/github-action-auto-format/releases for a list of available versions.

Examples

Here's a real world example:

github-action-auto-format - Cloud Posse's self-testing Auto-Format GitHub Action

Like this project? Please give it a ★ on our GitHub! (it helps us a lot)

Are you using this project or any of our other projects? Consider leaving a testimonial. =)

Check out these related projects.

GitHub Action Auto-Release - Automatically draft release notes for a new release when merges are made into the default branch
GitHub Action Terraform Auto-context - Automatically update context.tf whenever a new version becomes available
GitHub Action Terraform CI - Full suite of Terraform CI actions, along with chatops support
GitHub Action Validate CODEOWNERS - Validate and lint contents of CODEOWNERS file

References

For additional context, refer to some of these links.

GitHub Action - Checkout - Checks out a repository under $GITHUB_WORKSPACE, so a workflow can access it
Create Pull Request - Take all unpushed commits and modifications to the code and put it on a new branch with a PR already made

Help

Got a question? We got answers.

File a GitHub issue, send us an email or join our Slack Community.

DevOps Accelerator for Startups

We are a DevOps Accelerator. We'll help you build your cloud infrastructure from the ground up so you can own it. Then we'll show you how to operate it and stick around for as long as you need us.

Work directly with our team of DevOps experts via email, slack, and video conferencing.

We deliver 10x the value for a fraction of the cost of a full-time engineer. Our track record is not even funny. If you want things done right and you need it done FAST, then we're your best bet.

Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
Release Engineering. You'll have end-to-end CI/CD with unlimited staging environments.
Site Reliability Engineering. You'll have total visibility into your apps and microservices.
Security Baseline. You'll have built-in governance with accountability and audit logs for all changes.
GitOps. You'll be able to operate your infrastructure via Pull Requests.
Training. You'll receive hands-on training so your team can operate what we build.
Questions. You'll have a direct line of communication between our teams via a Shared Slack channel.
Troubleshooting. You'll get help to triage when things aren't working.
Code Reviews. You'll receive constructive feedback on Pull Requests.
Bug Fixes. We'll rapidly work with you to fix any bugs in our projects.

Slack Community

Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" 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 sweet infrastructure.

Discourse Forums

Participate in our Discourse Forums. Here you'll find answers to commonly asked questions. Most questions will be related to the enormous number of projects we support on our GitHub. Come here to collaborate on answers, find solutions, and get ideas about the products and services we value. It only takes a minute to get started! Just sign in with SSO using your GitHub account.

Sign up for our newsletter that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover.

Fork the repo on GitHub
Clone the project to your own machine
Commit changes to your own branch
Push your work back up to your fork
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!

Copyrights

License

See LICENSE for full details.

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.

About

This project is maintained and funded by Cloud Posse, LLC. Like it? Please let us know by leaving a testimonial!

We're a DevOps Professional Services company based in Los Angeles, CA. We ❤️ Open Source Software.

We offer paid support on all of our projects.

Check out our other projects, follow us on twitter, apply for a job, or hire us to help with your cloud strategy and implementation.

Contributors

Dylan Bannon

GitHub Action

github-action-auto-format