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

fix md_mpx_format_adjuster.py script #1594

Closed
wants to merge 4 commits into from

Conversation

dhiraj0911
Copy link

What kind of change does this PR introduce?

  • Bugfix for the automated documentation GitHub action PUSH workflow.
  • Standardizes package manager to npm for both talawa-api and talawa-admin.
  • Adds a Python script (md_mpx_format_adjuster.py) to ensure Markdown files are MPX compatible.

Issue Number: #1559


Did you add tests for your changes?

  • No new tests added. The changes pertain to the GitHub Actions workflow and documentation updates.
  • Manual testing was conducted to ensure functionality and MPX compatibility.

If relevant, did you update the documentation?

  • Documentation updated to reflect the shift from npm to yarn and the integration of script.py.
  • Details on workflow changes and MPX compatibility considerations with Docusaurus v3 included.

Summary

  • Addresses issues with GitHub action for automated documentation generation.
  • Resolves inconsistencies in package managers and non-compliance with Docusaurus v3's MPX standards.
  • Includes transition to yarn and introduction of script.py for Typedoc-generated Markdown files.

Does this PR introduce a breaking change?

  • No breaking changes introduced.
  • Focuses on resolving workflow issues and enhancing compatibility, not affecting core software functionality.

Have you read the contributing guide?

  • Yes, the contributing guidelines have been followed.

Copy link

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. Our test code coverage system will fail if these conditions occur:

  1. The overall code coverage drops below the target threshold of the repository
  2. Any file in the pull request has code coverage levels below the repository threshold
  3. Merge conflicts

The process helps maintain the overall reliability of the code base 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. 🎯 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.
  2. Read the CONTRIBUTING.md file make

Copy link
Contributor

@palisadoes palisadoes left a comment

Choose a reason for hiding this comment

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

  1. See comment.
  2. Have you discovered why this workflow isn't' communicating with Talawa Docs? We'll need to know fairly certainly that this will work before we deploy it.

.github/workflows/push.yml Outdated Show resolved Hide resolved
@palisadoes
Copy link
Contributor

Please work with @noman2002 on this. He'll be taking over the review of this PR

@palisadoes palisadoes requested a review from noman2002 December 29, 2023 19:00
Copy link

codecov bot commented Dec 29, 2023

Codecov Report

Attention: 91 lines in your changes are missing coverage. Please review.

Comparison is base (c0468a4) 98.17% compared to head (4789e7e) 97.45%.
Report is 166 commits behind head on develop.

❗ Current head 4789e7e differs from pull request most recent head 380f6e1. Consider uploading reports for the commit 380f6e1 to get more accurate results

Files Patch % Lines
src/utilities/PII/decryption.ts 0.00% 17 Missing ⚠️
src/resolvers/Mutation/updateUserProfile.ts 70.90% 1 Missing and 15 partials ⚠️
src/resolvers/middleware/currentUserExists.ts 45.83% 13 Missing ⚠️
src/utilities/PII/encryption.ts 0.00% 13 Missing ⚠️
src/utilities/PII/isAuthorised.ts 0.00% 11 Missing ⚠️
...tilities/encodedVideoStorage/uploadEncodedVideo.ts 90.12% 8 Missing ⚠️
src/resolvers/Mutation/createPost.ts 86.95% 6 Missing ⚠️
src/resolvers/Mutation/removeAdvertisement.ts 92.85% 2 Missing ⚠️
...c/resolvers/Query/postsByOrganizationConnection.ts 33.33% 2 Missing ⚠️
src/resolvers/Subscription/onPluginUpdate.ts 0.00% 2 Missing ⚠️
... and 1 more
Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #1594      +/-   ##
===========================================
- Coverage    98.17%   97.45%   -0.73%     
===========================================
  Files          184      214      +30     
  Lines        10767    12949    +2182     
  Branches       835     1042     +207     
===========================================
+ Hits         10571    12620    +2049     
- Misses         186      299     +113     
- Partials        10       30      +20     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@palisadoes
Copy link
Contributor

@Nitya-Pasrija Please be aware of this PR

@palisadoes
Copy link
Contributor

Please fix the conflicting file

@Nitya-Pasrija
Copy link
Contributor

On it

Copy link
Contributor

@palisadoes palisadoes left a comment

Choose a reason for hiding this comment

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

  1. See comment
  2. Have you determined whether the API workflow is updating the Talawa-Docs repository?

INSTALLATION.md Outdated
@@ -6,42 +6,46 @@ This document provides instructions on how to set up and start a running instanc

<!-- TOC -->

- [Talawa-API Installation](#talawa-api-installation)
Copy link
Contributor

Choose a reason for hiding this comment

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

This file must not be included in this PR

@palisadoes
Copy link
Contributor

Please fix the conflicting files

@palisadoes
Copy link
Contributor

@dhiraj0911

  1. Please fix the conflicting files.
  2. Have you tested this exporting to Talawa-Docs

@dhiraj0911
Copy link
Author

I've changed destination_branch to develop to see changes but not appearing there as verify-workflow branch was not there

@palisadoes
Copy link
Contributor

palisadoes commented Jan 5, 2024

Please reach out to Noman on Slack to schedule a time over the weekend for both of you to troubleshoot this. He's very busy during the week. Both of you are in the same time zone so it will be easier to fix it quickly.

Try to get both related PRs solved and merged.

@dhiraj0911
Copy link
Author

Okay, thanks

@palisadoes
Copy link
Contributor

@dhiraj0911

  1. Please fix the conflicting files
  2. Have you managed to contact @noman2002?
  3. You still haven't reported confirmation that the workflow is copying files to Talawa-Docs successfully

@dhiraj0911
Copy link
Author

Yes, I messaged him on slack waiting for his reply

@dhiraj0911
Copy link
Author

Till now I would like to contribute to other issues, can you assign them to me?

@palisadoes
Copy link
Contributor

Till now I would like to contribute to other issues, can you assign them to me?

I've assigned the original issue to myself

Copy link

This pull request did not get any activity in the past 10 days and will be closed in 180 days if no update occurs. Please verify it has no conflicts with the develop branch and rebase if needed. Mention it now if you need help or give permission to other people to finish your work.

@github-actions github-actions bot added the no-pr-activity No pull request activity label Jan 19, 2024
@palisadoes palisadoes closed this Jan 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-pr-activity No pull request activity
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants