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

Use config file #53

Merged
merged 40 commits into from
May 23, 2021
Merged

Use config file #53

merged 40 commits into from
May 23, 2021

Conversation

PuneetGopinath
Copy link
Member

@PuneetGopinath PuneetGopinath commented May 22, 2021

Checks

I have...

  • read and understood the Contributing Guidelines
  • Updated any nessecary files such as the README.md and/or CHANGELOG.md.

Type of Pull request

  • Minor Change
    This Pull request doesn't break existing configuration.
  • Major Change
    This Pull request will break existing configuration.
  • Bug fix
    This Pull request will fix a (critical) bug.
  • Documentation
    This Pull request only changes documentation (README.md, CHANGELOG.md, etc.)
  • Other: __________

Description

See #52 for the details, etc.

Closes #52

@abhijoshi2k
Copy link
Member

@PuneetGopinath FYI, TIMEZONE_OFFSET is going to be renamed with TIMEZONE
You do not need to change it in any of the current file as I'll do it on other branch and then merge. You just have to take care of it in new YAML

@abhijoshi2k
Copy link
Member

@PuneetGopinath please run npm i on your side and commit the new package-lock.json to run build successfully

@PuneetGopinath
Copy link
Member Author

@PuneetGopinath please run npm i on your side and commit the new package-lock.json to run build successfully

That's what I asked you in #52, now I will do it.

@PuneetGopinath
Copy link
Member Author

@abhijoshi2k Can you check the commit "Fix index.js", that whether it will work or not?

@PuneetGopinath
Copy link
Member Author

PuneetGopinath commented May 22, 2021

@abhijoshi2k Why is prettier checking dist/index.js, I think you added dist/index.js to the .prettierignore, so it shoulld check that file

@abhijoshi2k
Copy link
Member

@abhijoshi2k Can you check the commit "Fix index.js", that whether it will work or not?

No. that won't work.
You don't need to make any changes to any file other than config.js and parseYaml.js
config.js should export exact same values as it was exporting before

@abhijoshi2k
Copy link
Member

Try using spread operator again while exporting. f.e. ...conf

@PuneetGopinath
Copy link
Member Author

PuneetGopinath commented May 22, 2021

@abhijoshi2k Why is prettier checking dist/index.js, I think you added it to the .prettierignore

@abhijoshi2k
EDIT: See https://github.com/Readme-Workflows/recent-activity/pull/53/checks?check_run_id=2645996290

@abhijoshi2k
Copy link
Member

@abhijoshi2k Why is prettier checking dist/index.js, I think you added it to the .prettierignore

@abhijoshi2k
EDIT: See https://github.com/Readme-Workflows/recent-activity/pull/53/checks?check_run_id=2645996290

It's programmed to format all files ending with .js. That might be the reason

@PuneetGopinath
Copy link
Member Author

It's programmed to format all files ending with .js. That might be the reason

Can you fix that?

@abhijoshi2k
Copy link
Member

It's programmed to format all files ending with .js. That might be the reason

Can you fix that?

I tried. But couldn't. That's fine. It won't cause any issue.

@abhijoshi2k
Copy link
Member

@PuneetGopinath I feel there's a better way to structure config.js. Would you like me to make a commit?

@PuneetGopinath
Copy link
Member Author

@PuneetGopinath I feel there's a better way to structure config.js. Would you like me to make a commit?

Sure, that's what I said in #52

I will assign this to my self if you agree with this request and plz help me in the process of doing it.

@PuneetGopinath
Copy link
Member Author

@abhijoshi2k I am receiving too many emails for this failing workflow, can we remove it to run on PRs.

@PuneetGopinath
Copy link
Member Author

@abhijoshi2k You shouldn't use those vars as we are going to remove them in config.js and action.yml

@abhijoshi2k
Copy link
Member

abhijoshi2k commented May 22, 2021

@abhijoshi2k You shouldn't use those vars as we are going to remove them in config.js and action.yml

Let's not remove them. It'll automatically take default value and then replace it as per user's YML file.
Users will have a choice between using same yml or separate one

@abhijoshi2k
Copy link
Member

@abhijoshi2k I am receiving too many emails for this failing workflow, can we remove it to run on PRs.

It's working on local though. IDK what's the issue here

@github-actions github-actions bot added the Updates: documentation Improvements or additions to documentation label May 23, 2021
@abhijoshi2k
Copy link
Member

abhijoshi2k commented May 23, 2021

@abhijoshi2k @Andre601 Can you check the updated wiki?

I think the inputs should be shown on top. Also, link to sample.yml is incorrect.

Also, I have updated the disabled_events in sample.yml. You will need to update that in wiki
review_approved is changed to changes_approved.
You need to mention that all of the options are optional.

Instead of giving link to sample.yml, I think we should simply provide the contents of the file on wiki.

@PuneetGopinath
Copy link
Member Author

@abhijoshi2k @Andre601 Can you check the updated wiki?

I think the inputs should be shown on top. Also, link to sample.yml is incorrect.

The link will return a 404 as the file is not in branch main

@PuneetGopinath
Copy link
Member Author

PuneetGopinath commented May 23, 2021

@Andre601 Sorry for updating the wiki, I rebased and force pushed so my commit is dropped.
Can you add the Inputs sections and what @abhijoshi2k requested?
The inputs section can be something like this:



## Inputs

These are the inputs you can supply through github actions (that you can set through the `with` option in a workflow file)

<table>
  <thead>
    <tr>
      <th>Option</th>
      <th>Description</th>
      <th>Default</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><code>GH_USERNAME</code></td>
      <td>The User to get latest activity from</td>
      <td><i>Repository Owner</i></td>
    </tr>
    <tr>
      <td><code>CONFIG_FILE</code></td>
      <td>The location of the configuration file, remember to add `./` before the path to the file.</td>
      <td><i>./.github/recent-activity.config.yml</i></td>
    </tr>
  </tbody>
</table>

@abhijoshi2k
Copy link
Member

@abhijoshi2k @Andre601 Can you check the updated wiki?

I think the inputs should be shown on top. Also, link to sample.yml is incorrect.

The link will return a 404 as the file is not in branch main

Okay.

@Andre601
Copy link
Member

The link to the sample.yml doesn't work because the file has yet to be added to the main branch.

@Andre601 Andre601 removed the Updates: documentation Improvements or additions to documentation label May 23, 2021
@Andre601
Copy link
Member

Also, I have updated the disabled_events in sample.yml. You will need to update that in wiki
review_approved is changed to changes_approved.
You need to mention that all of the options are optional.

Instead of giving link to sample.yml, I think we should simply provide the contents of the file on wiki.

Updated the wiki.
Also, I intentionally link to the file instead of having a copy of it on the wiki. Reason for that is, that in case of the file changing, we don't have to update the wiki as much...

@abhijoshi2k
Copy link
Member

The home and example wiki also need to be updated right? @Andre601

@PuneetGopinath
Copy link
Member Author

The home and example wiki also need to be updated right? @Andre601

@Andre601

@Andre601
Copy link
Member

image

@Andre601
Copy link
Member

@Andre601 Can I add a footer in wiki?

Go ahead.

@PuneetGopinath
Copy link
Member Author

@Andre601 Can I add a footer in wiki?

Go ahead.

Check it out now.

@PuneetGopinath PuneetGopinath marked this pull request as ready for review May 23, 2021 08:35
@PuneetGopinath PuneetGopinath requested a review from Andre601 as a code owner May 23, 2021 08:35
@PuneetGopinath
Copy link
Member Author

We have to resolve conflicts

@github-actions github-actions bot added the Updates: documentation Improvements or additions to documentation label May 23, 2021
@abhijoshi2k abhijoshi2k added Status: Ready The Pull request is ready for reviews and getting merged and removed Status: In progress This pr or issue is in progress labels May 23, 2021
@github-actions
Copy link
Contributor

The Pull request of @PuneetGopinath has been marked as Ready!

It can now be reviewed and/or merged by Maintainers.


This is an automated response created by a GitHub Action
Mentioning the bot won't have any effect!

@PuneetGopinath PuneetGopinath merged commit 6bfb4e9 into main May 23, 2021
@PuneetGopinath PuneetGopinath deleted the add-config-file branch May 23, 2021 08:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
major Will be added to next major release Priority: medium Medium priority for this issue/pr. Status: Ready The Pull request is ready for reviews and getting merged Type: breaking This change will break previous versions Type: enhancement New feature or request Updates: documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Feature request: Keep the configuration in a file
3 participants