foundry CLI game plan

README.md

There are a lot of moving parts to get foundry onto using CLI's over plugins. This document is to help us coordinate that movement.

• Update foundry-release-spec
  • Add missing link + release it
• Re-read docs and write down any major points we want to hit (e.g. config we want to use)
  • https://gist.github.com/twolfson/2675196c629b373124d8
  • https://gist.github.com/twolfson/e2bd549967eac292c9b5
  • https://gist.github.com/twolfson/1f269af2d4e3a120ff48
  • https://gist.github.com/twolfson/1eeb9a4610b9311b3126
  • https://gist.github.com/twolfson/2d0e3d2e1efd08274d29
• Write foundry-release-base
  • Class based commander integration that copy/pastes documentation from existing `foundry-release-spec
  • Return class for extension as well as something to help with parsing?
• Move all of foundry-release-plugins to foundry-release-base
  • Update .travis.yml
  • Replace plugin with command
  • Document actions taken for each step (e.g. publish -> npm publish)
  • Add foundry-release-base + bin/
  • Add bin/ to package.json
  • Update engine: node in package.json
  • Add foundry-* to devDependencies in package.json
    • npm install foundry foundry-release-git foundry-release-npm --save-dev
  • Add foundry config to package.json
  • Add release.sh
  • Update CHANGELOG and release
• Move foundry to look at CLIs as specified in our config/package.json (e.g. use --spec-version)

Nice to add shortly after:

• Update screenshot for foundry
• Update title for foundry-release-spec (currently says plugins)
• Update title for foundry (currently says plugins)
• Move keywords from foundry-release-plugin to foundry-release-command (including foundry docs)
  • We use foundry-release as the keyword, no adjustments are required
• Write foundry-cli
  • Update foundry docs with foundry-cli
  • Add foundry setup to our grunt-init repos
  • Add Releasing section to repos?
    • Consider this as a won't fix for now
• Update screenshot in foundry to use foundry.cli. We took one but are too tired to handle it now
• Add support for registerVersion
• Add resume support by dumping list of commands that were not run/failed to completely run
  • We have progress by running each of our commands (yey)
• Add major, minor, patch support
  • Going to consider this non-critical (I think we have gotten too complacent with our current semver specified flow)
• Add --dry-run support to release
• Add private flag inside foundry itself to skip register/publish when the underlying tool doesn't support it
  • Probably can't do this since git would still require register/publish
  • Yep, won't fix
• Create Mailchimp newsletter
• Revisit issues created on foundry
  • https://github.com/twolfson/foundry/issues
• Test foundry and foundry-cli on Windows

Out of scope:

• Move foundry-release-python to Python script so we get nice AST support
  • I keep on getting overwhelmed at how many cases there are for this. Closing for now =/
    • Inline in the setup.py
    • Standalone version.txt file
    • Inline in __init__.py or similar
• gh-releases support via releases/ dir which has .md + YAML front matter to upload per version
  • If not found, bail
  • There are plenty of GitHub CLI release libraries
    • https://github.com/remixz/publish-release
    • https://github.com/ngoldman/gh-release
  • Instead of rolling our own, let's accept theirs as a customCommand
  • Although, I am prob going to document this variation in our good ideas that won't get done
• Write bower's register function gdi
  • twolfson/foundry-release-bower#1

CONFIG.md

This is the goal for our project's package.json:

foundry: {
  // Invokes all `--spec-version`, etc commands
  // DEV: While this is more verbose than something like `releaseOverrides`
  //    it is more representative of how we want integrations to go
  //    - Typically append-only
  //    - Prefer a command integration over explicit CLI calls (since the long form is more verbose)
  // DEV: Additionally, we could still roll `releaseOverrides: {updateFiles: []}` which is a full override
  releaseCommands: [
    'foundry-release-git',
    {
      // Same as above
      type: 'release-command',
      command: 'foundry-release-npm'
    },
    {
      type: 'custom-command',
      updateFiles: 'custom-command "$FOUNDRY_VERSION" "$FOUNDRY_MESSAGE"'
    }
  ],
  registerAt: '1.0.0' // Required key (but not required for v3)
}