search

PalisadoesFoundation / talawa-docs

Documentation for Talawa and Talawa-API
https://docs.talawa.io/
GNU General Public License v3.0
44 stars 146 forks source link

Feat: Implement automated updates with Dependabot (#694) #696

Closed Harsh1s closed 10 months ago

Harsh1s commented 10 months ago

Configure automated Dependabot updates to keep the codebase current on the develop branch. This aligns with Talawa's setup, running weekly updates against the default branch, using the correct package system and root directory.

Closes #694

What kind of change does this PR introduce?

Issue Number:

Fixes #694

Did you add tests for your changes?

Snapshots/Videos:

N/A

If relevant, did you update the documentation?

N/A

Summary

Configure automated Dependabot updates to keep the codebase current on the develop branch. This aligns with Talawa's setup, running weekly updates against the default branch, using the correct package system and root directory.

Does this PR introduce a breaking change?

Other information

N/A

Have you read the contributing guide?

github-actions[bot] commented 10 months ago

Our Pull Request Approval Process

We have these basic policies to make the approval process smoother for our volunteer team.

Testing Your Code

Please make sure your code passes all tests and there are no merge conflicts.

The process helps maintain accurate and well-formatted documentation and is a prerequisite for getting your PR approved. Assigned reviewers regularly review the PR queue and tend to focus on PRs that are passing.

Reviewers

When your PR has been assigned reviewers contact them to get your code reviewed and approved via:

  1. comments in this PR or
  2. our slack channel

Reviewing Your Code

Your reviewer(s) will have the following roles:

  1. arbitrators of future discussions with other contributors about the validity of your changes
  2. point of contact for evaluating the validity of your work
  3. person who verifies matching issues by others that should be closed.
  4. person who gives general guidance in fixing your tests

CONTRIBUTING.md

Read our CONTRIBUTING.md file. Most importantly:

  1. PRs with issues not assigned to you will be closed by the reviewer
  2. Fix the first comment in the PR so that each issue listed automatically closes

Other

  1. :dart: Please be considerate of our volunteers' time. Contacting the person who assigned the reviewers is not advised unless they ask for your input. Do not @ the person who did the assignment otherwise.
palisadoes commented 10 months ago

Please take a look at Docusaurus' configuration file to see what we may require. We don't want the github-actions section as this is not a very highly active repo

Harsh1s commented 10 months ago

Please take a look at Docusaurus' configuration file to see what we may require. We don't want the github-actions section as this is not a very highly active repo

I went through this file and needed your help understanding the requirements. The only actual difference is that I have not used the open-pull-requests-limit: 0 part. But from my understanding, that is used to disable the version updates for npm dependencies. So is this true for this dependency too? Does it need disabling the version updates for npm dependencies?

EshaanAgg commented 10 months ago

IMO we should also update the npm dependencies until they do not break the build; otherwise, we are setting up ourselves for a technical backlog in the future.

palisadoes commented 10 months ago

Yes we have had this outdated dependency difficulty in the past. They should be updated. That is why we decided to restore the dependabot workflow

Harsh1s commented 10 months ago

Yes we have had this outdated dependency difficulty in the past. They should be updated. That is why we decided to restore the dependabot workflow

So I guess my original PR should work, I'll redo it without the open-pull-requests-limit: 0 argument.