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

GitHub Action documentation #52

Closed
3 tasks done
almereyda opened this issue Mar 29, 2020 · 3 comments
Closed
3 tasks done

GitHub Action documentation #52

almereyda opened this issue Mar 29, 2020 · 3 comments
Labels
status: awaiting author response Additional information has been requested from the author type: documentation An issue or pull request for improving or updating documentation type: question or discussion Issue discussing or asking a question

Comments

@almereyda
Copy link

almereyda commented Mar 29, 2020

Checklist

  • I checked that this is not an existing issue
  • I gave clear steps to reproduce this issue
  • I formatted all code samples correctly (if relevant)

Expected Behavior

A command like

stargazed --username almereyda --token of_sorts --sort --repository awesome-stars -w

sets up a GitHub repository, if not existing, and Action for updating the repository.

Current Behavior

  1. Running the command without the repository existing does not create it with an initial commit and does not set the GitHub Action.
  2. Running the command for a manually created repository does not create a commit and does not create a visible action in https://github.com/almereyda/awesome-stars/actions/new

Possible Solution

stargazed is able to fetch the repository's configuration If the repository does not yet exist, it is being created and set up with an initial commit plus GitHub Action. (Note the -w flag.)

Steps to Reproduce

  1. Run the stargazed command above with your username and your personal access token.
  2. Review the GitHub Actions

Context (Environment)

This is a Fedora 30, Node 10 environment.

Possible Implementation

It could be nice to have a CLI flag that can read the repository configuration and update on the status of an eventual integration.

@abhijithvijayan abhijithvijayan added type: bug An issue or pull request relating to a bug in this project and removed type: bug An issue or pull request relating to a bug in this project labels Mar 29, 2020
@abhijithvijayan
Copy link
Owner

abhijithvijayan commented Mar 29, 2020

@almereyda This is not a bug as the --repository flag doesn't exist. which is --repo instead.

I can't change --repo as this will cause breaking changes to all those users who have set up workflow.

This works for a manually created repository as well(with preexisting commits also)

Maybe I will alias it so as to accept both --repo and --repository flags to not cause confusion among users.

Try to use short aliases like -r for repository

@abhijithvijayan abhijithvijayan added status: awaiting author response Additional information has been requested from the author type: documentation An issue or pull request for improving or updating documentation type: question or discussion Issue discussing or asking a question labels Mar 29, 2020
@abhijithvijayan
Copy link
Owner

Have aliased --repository flag

Use npx to use the latest version of CLI

I am closing this for now.

If you still have issue, feel free to reopen this.

@almereyda
Copy link
Author

almereyda commented Apr 1, 2020 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: awaiting author response Additional information has been requested from the author type: documentation An issue or pull request for improving or updating documentation type: question or discussion Issue discussing or asking a question
Projects
None yet
Development

No branches or pull requests

2 participants