Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds CLI for Faros CE #213

Merged
merged 24 commits into from
Oct 12, 2022
Merged

Adds CLI for Faros CE #213

merged 24 commits into from
Oct 12, 2022

Conversation

ypc-faros
Copy link
Contributor

@ypc-faros ypc-faros commented Sep 27, 2022

Description

Adds a CLI to quickly set up and sync a few vcs sources.

The CLI can be invoked with no parameters and it will show a number of prompts for the user to choose a source and then source specific parameters (e.g., for github, a github token and repos to sync).

The CLI can also be invoked with subcommands (one per source: github, bitbucket (+ gitlab, jira coming soon) ). One can enter some of the source specific arguments (e.g., --token for github) and the corresponding prompt for that parameter will be skipped.

The integration tests rely on a per-source json configuration to be specified as secrets in the github workflows. Those can also be run manually:

GITHUB_TOKEN=XYZ npm run test:integration -- --coverage

Changes to follow in upcoming PRs:

  • Support for jira and gitlab.

Fixes # (issue)

Type of change

(Delete what does not apply)

  • New feature (non-breaking change which adds functionality)
  • This change requires a documentation update

Checklist

(Delete what does not apply)

  • Have you checked to there aren't other open Pull Requests for the same update/change?
  • Have you lint your code locally before submission?
  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your core changes, as applicable?
  • Have you successfully run tests with your changes locally?

@ypc-faros ypc-faros changed the title Ypc/cli FAI-3157 CLI Sep 27, 2022
@ypc-faros ypc-faros marked this pull request as draft September 27, 2022 18:19
@tovbinm tovbinm changed the title FAI-3157 CLI Adds CLI for Faros CE Sep 27, 2022
@ypc-faros ypc-faros marked this pull request as ready for review September 27, 2022 19:50
demo.sh Outdated Show resolved Hide resolved
.github/workflows/pr.yml Outdated Show resolved Hide resolved
.github/workflows/pr.yml Outdated Show resolved Hide resolved
Copy link
Contributor

@thomas-gerber thomas-gerber left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK to merge
We will add in separate PRs:

  1. better explanation of how the space bar needs to be used to select
  2. limits on repos/projects
  3. Jira / Bitbucket support
  4. replace clone with some curl downloads

@ypc-faros ypc-faros merged commit 4d9b2dc into main Oct 12, 2022
@ypc-faros ypc-faros deleted the ypc/cli branch October 12, 2022 21:58
@github-actions github-actions bot locked and limited conversation to collaborators Oct 12, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants