You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This was built to run foundry and node-based foundry-release commands without needing to modify the PATH environment variable for every release.
Getting Started
Install the module globally with: npm install -g foundry.cli
Then, navigate to a project with foundry installed and run foundry as if it's not inside of node_modules/:
foundry commands
# Lists out commands used for project
Here's a demonstration with a local-only git repository
# Create git repo
mkdir foundry-example
cd foundry-example
git init
echo"Hello World"> README.md
git add README.md
git commit -m "Added documentation"# Generate `package.json` with `foundry` config
cat > package.json <<EOF{ "foundry": { "releaseCommands": [ "foundry-release-git" ] }}EOF# Locally install `foundry` and corresponding `git` foundry-release command
npm install foundry foundry-release-git
# Run our release with the globally installed foundry
foundry release 1.0.0
# Configuring steps with FOUNDRY_VERSION: 1.0.0# Configuring steps with FOUNDRY_MESSAGE: Release 1.0.0# Running step: foundry-release-git update-files "$FOUNDRY_VERSION" "$FOUNDRY_MESSAGE"# Running step: foundry-release-git commit "$FOUNDRY_VERSION" "$FOUNDRY_MESSAGE"# [master ec7a32d] Release 1.0.0# Running step: foundry-release-git register "$FOUNDRY_VERSION" "$FOUNDRY_MESSAGE"# Running step: foundry-release-git publish "$FOUNDRY_VERSION" "$FOUNDRY_MESSAGE"# Pushes to remote server# See the release commit and tag
git log --decorate --oneline
# c6ce921 (HEAD, tag: 1.0.0, master) Release 1.0.0# f0c25b3 Added documentation
Documentation
When installed, we provide a CLI tool with the name foundry
# Directly invoke `foundry` located in `$PWD/node_modules/.bin/`
foundry
# Help prompt will be for the corresponding `foundry` package
foundry --help
# Usage: foundry [options] [command]
Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint via npm run lint and test via npm test.