Standardized Project Scripting

5 posts · Jun 2015 – Jul 2022

What this trail covers

This feature thread tracks the evolution of standardizing project scripting conventions to streamline the developer experience. Initially, the focus was on establishing common script names for bootstrapping, testing, and running applications across all GitHub projects. This post details the use of GitHub CLI to capture different GitHub workflows by leveraging plain text as a universal interface, enabling customization through aliases and pagers, combining `gh` with other tools like fzf, and using `gh` within GitHub Actions and for API interactions.

All GitHub trails

Jul 2022How the GitHub Security Team uses projects and GitHub Actions for planning, tracking, and moreThis post details how the GitHub Security Team uses GitHub Projects and GitHub Actions to create an "organizational operating system." It explains how Projects is used for planning and tracking initiatives, with issues cross-referenced and assigned DRIs. GitHub Actions are used to automate tasks like bulk issue creation, adding issues to project boards, and automatically updating project boards based on status updates. A specific example of a composite GitHub Action for updating project board fields is provided.
May 2022How we’re using projects to build projectsThis post details the use of GitHub Projects and GitHub Actions to automate planning, tracking, and organizational work for the Security Team, creating an "organizational operating system." It highlights how Projects allows for flexible project management and workflow automation, extending the capability beyond just scripting to broader organizational workflows.
Apr 2021How we use GitHub Actions to manage GitHub DocsThis post details the specific implementation of GitHub Actions workflows for project management within the GitHub Docs team. It outlines several workflows: 'Triage new issues' for labeling and moving new issues, 'Check for Spammy Issues' to close spam, 'No response' to close issues without replies, 'Transfer REST API issue to rest-api-description' and 'Copy to REST API issue to docs-content' for managing API-related issues across repositories, 'Move help wanted issues' to organize community contributions, 'Check unallowed file changes' for PR validation, 'Triage new pull requests' for PR management, 'Move and unlabel ready to merge PRs' for merging approved PRs, 'Merge notification' to inform contributors of deployment, and 'Public Repo Stale Check' to manage inactive PRs. The post emphasizes the use of GitHub Actions and APIs for automating these project management tasks.
Mar 2021Scripting with GitHub CLIThis post details how to leverage GitHub CLI (gh) for scripting and workflow automation. It covers customizing `gh` with aliases and pagers (like `less` and `delta`), combining `gh` with fuzzy-finders (`fzf`) for interactive selection, and using `gh` within GitHub Actions for tasks like enabling auto-merge and creating releases. It also introduces `gh api` for interacting with the GitHub REST and GraphQL APIs, demonstrating dynamic query construction and JSON processing with `jq`.
Jun 2015Scripts to Rule Them AllThis post introduces the 'Scripts to Rule Them All' pattern, standardizing script names across GitHub projects for common development tasks such as bootstrapping, testing, and running applications. It defines specific script names like `script/bootstrap`, `script/setup`, `script/update`, `script/server`, `script/test`, `script/cibuild`, and `script/console`. The pattern emphasizes composability, language agnosticism, and reducing contributor friction by abstracting away project-specific implementation details.
Advertisement