https://github.com/dxw/scripts-to-rule-them-all

Template scripts to use in projects, based on GitHub's pattern with the same name
https://github.com/dxw/scripts-to-rule-them-all

delivery-plus internal

Last synced: 21 days ago
JSON representation

Template scripts to use in projects, based on GitHub's pattern with the same name

• Host: GitHub
• URL: https://github.com/dxw/scripts-to-rule-them-all
• Owner: dxw
• License: mit
• Created: 2020-07-18T18:55:54.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-04-05T04:49:20.000Z (9 months ago)
• Last Synced: 2024-04-06T02:10:47.592Z (9 months ago)
• Topics: delivery-plus, internal
• Language: Shell
• Homepage:
• Size: 55.7 KB
• Stars: 3
• Watchers: 12
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# dxw's Scripts to Rule Them All

Template scripts to use in projects, based on

[GitHub's pattern](https://github.com/github/scripts-to-rule-them-all) with the

same name.

## Installation

For each language or stack, we have a set of scripts. To add them to a project,

copy the full contents of the most appropriate folder to the root of the project

and edit as needed. `base` is a good starting point if there's nothing more

appropriate.

## Contents

The template scripts for each language or stack assume the use of dxw's standard

tools.

### `script/bootstrap`

`script/bootstrap` should install all dependencies required to develop, build,

and run the application.

The script can assume that any macOS environment uses Homebrew for package

management and already has it installed. It can also assume that any

non-development environment (such as CI) will install system dependencies prior

to running the script.

### `script/setup`

`script/setup` should set the application up in its initial state. If this isn't

the first time working on a application, that means clearing any data or build

artefacts, to return the application to a pristine state.

This should run `script/bootstrap` as an early step.

### `script/update`

`script/update` should update the application to the latest configuration from

any earlier version. This should update any dependencies and run any database

migrations.

This should run `script/bootstrap` as an early step.

### `script/test`

`script/test` should run the full test suite, including any linters. Linting

tends to run faster than tests, so it's useful to put them first, so the suite

fails faster.

A useful pattern to support is having an optional argument, a file path or

pattern, for running a subset of the full suite.

This script should support being run in CI environments. If detection of the CI

environment is required, use the presence of a `CI` environment variable.

This should run `script/update` as an early step.

### `script/server`

If appropriate, `script/server` should start the application and any additional

processes needed to support it.

This should run `script/update` as an early step.

### `script/build`

If appropriate, `script/build` should create a production build of the

application.

A useful pattern to support is having an optional argument to specify the target

environment to build for.

This should run `script/update` as an early step.

### `script/console`

If appropriate, `script/console` should open a console for the application.

A useful pattern to support is having an optional argument to specify an

environment, to support connecting to other environments, like staging or

production. By default, it should connect to the local development environment.

This should also do any setup required to connect to the console for the given

environment.

### No `script/cibuild`

We choose not to use a single build script for CI, preferring instead to have

explicit steps in our CI configuration.