Skip to content

Latest commit

 

History

History
74 lines (45 loc) · 3.92 KB

README.md

File metadata and controls

74 lines (45 loc) · 3.92 KB
Raw

🔄 OSPO Automation

Release Lint License: MIT Contributor Covenant Maintainer

About The Project

Automation workflows for Wayfair's Open Source Program Office.

Self-Service

Wayfair developers who wish to fork an open source repository into /wayfair-contribs for upstream contributions can now leverage our self-service PR workflow.

🎉 Please review the Fork a repository README to get started!

In the future, developers will also leverage PR workflows to request new projects in /wayfair-incubator, nominate mature projects to 'graduate' to /wayfair, and more.

💡 During the beta rollout of this fully self-service workflow, you may encounter some errors or edge cases we have not accounted for yet. For any issues or feedback on using this workflow, please reach out to Wayfair OSPO internally on Slack (#open-source-forum) and we can lend a hand!

Internal Usage

Currently, the OSPO Automation project has a single workflow available for creating repository forks. Note that presently, this workflow is only intended for internal usage by the OSPO team. In the future, this workflow will become fully self-serviceable through an automated PR workflow.

To trigger this workflow manually, follow these steps:

  1. Navigate to the Actions tab of the project
  2. Locate the workflow you wish to run - in this case: fork
  3. Under the run history, you should see: This workflow has a workflow_dispatch event trigger
  4. Click the Run workflow button next to this message, and a dialogue box should open
  5. Fill out the required inputs to run the forker action
  6. Click the green Run workflow button at the bottom to manually trigger the workflow
  7. Watch your workflow spin into action in the run history!

Adding Workflows

To add new workflows to the project, follow these simple steps:

  1. Clone the repository:

    git clone https://github.com/wayfair/ospo-automation.git

  2. Create new GitHub workflows under .github/workflows:

    cd .github/workflows
touch my-cool-workflow.yml

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. For detailed contributing guidelines, please see CONTRIBUTING.md

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Gmail

Gatsby

Twitter

Acknowledgements

Repository template made with 💜 by Wayfair's Open Source Program Office.