joe-niland/.github

Organization GitHub Workflows & Community Files

This repository fulfills several unique functions functions for the Cloud Posse GitHub Organization.

1. It can contain special org-level files that provide functionality for our organization on GitHub. These files include:
   • profile/README.md
2. It can also act as a source for defaults of some repo-level files that might be found in a new GitHub repo's .github folder. In the event that a new repo is initialized without these files, the repo will behave on github.com as those the default copies of these files were present in the repo. These files include:
   • .github/CODEOWNERS
   • FUNDING.yml
   • .github/ISSUE_TEMPLATE/*
   • .github/PULL_REQUEST_TEMPLATE.md
3. In addition to these GitHub-mediated functions, we are also conscripting the cloudposse/.github repo to act as the source for all GitHub Actions workflows and other bootstrapping files that are copied out automatically to our repositories (and which we encourage others to copy to their own repositories) using our Auto-format GitHub Action. (Note that there is some overlap between the files that GitHub recognizes as repo-level default files and the files that we actively copy to our repos using the Auto-format action. This doesn't affect the functionality of either process, but it's worth noting for future reference.) Files that are distributed in this way include:
   • .github/auto-release.yml
   • .github/CODEOWNERS
   • .github/ISSUE_TEMPLATE/*
   • Makefile
   • .github/PULL_REQUEST_TEMPLATE.md
   • renovate.json
   • .github/workflows/*

---

Note

This project is part of Cloud Posse's comprehensive "SweetOps" approach towards DevOps.

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

Examples

To add all repository bootstrapping files to a new repo:

1. Copy the .github/workflows/auto-format.yml file from this repository to the .github/workflows folder of the destination repository.
2. Execute the Auto-format GitHub Action in the destination repository.

✨ Contributing

This project is under active development, and we encourage contributions from our community. Many thanks to our outstanding contributors:

🐛 Bug Reports & Feature Requests

Please use the issue tracker to report any bugs or file feature requests.

💻 Developing

If you are interested in being a contributor and want to get involved in developing this project or help out with Cloud Posse's other projects, we would love to hear from you! Shoot us an email.

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

1. Fork the repo on GitHub
2. Clone the project to your own machine
3. Commit changes to your own branch
4. Push your work back up to your fork
5. 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 "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.

📰 Newsletter

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.

📆 Office Hours

Join us every Wednesday via Zoom for our weekly "Lunch & Learn" sessions. It's FREE for everyone!

About

This project is maintained and funded by Cloud Posse, LLC.

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.

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.

Copyrights

Copyright © 2022-2024 Cloud Posse, LLC