forked from PalisadoesFoundation/talawa
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
24 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -94,8 +94,9 @@ jobs: | |
echo "Error: Close this PR and try again." | ||
exit 1 | ||
generate-docs: | ||
name: Update documentation | ||
Update-Documentation: | ||
if: github.ref == 'refs/heads/automated-docs' | ||
name: Update Documentation | ||
runs-on: ubuntu-latest | ||
environment: TALAWA_ENVIRONMENT | ||
steps: | ||
|
@@ -117,9 +118,9 @@ jobs: | |
flutter analyze | ||
dart analyze | ||
flutter pub global activate dartdoc | ||
flutter pub global run dartdoc . --output docs/docs/auto-docs --exclude=test/widget_tests/widgets/pinned_carousel_widget_test.dart, lib/widgets/pinned_carousel_widget.dart, lib/widgets/post_widget.dart, test/widget_tests/widgets/post_widget_test.dart | ||
rm -rf talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScrollerState/build.md | ||
rm -rf talawa-mobile-docs/widgets_post_widget/PostContainerState/build.md | ||
flutter pub global run dartdoc . --output docs/docs/auto-docs --format md --exclude=test/widget_tests/widgets/pinned_carousel_widget_test.dart, lib/widgets/pinned_carousel_widget.dart, lib/widgets/post_widget.dart, test/widget_tests/widgets/post_widget_test.dart | ||
rm -rf docs/docs/auto-docs/widgets_pinned_carousel_widget/CustomCarouselScrollerState/build.md | ||
rm -rf docs/docs/auto-docs/widgets_post_widget/PostContainerState/build.md | ||
- uses: actions/upload-artifact@v3 | ||
with: | ||
name: docs | ||
|
@@ -157,6 +158,24 @@ jobs: | |
git push | ||
echo -e "🚀${Green} Hurrah! doc updated${NoColor}" | ||
Documentation-to-talawa-docs: | ||
if: github.ref == 'refs/heads/develop-postgres' && ${{ github.actor != 'dependabot[bot]' }} | ||
name: Export Documentation to Auto-Docs | ||
runs-on: ubuntu-latest | ||
needs: Update-Documentation | ||
steps: | ||
- uses: actions/checkout@v4 | ||
- uses: dmnemec/[email protected] | ||
env: | ||
API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB_NEW }} | ||
with: | ||
source_file: "talawa-mobile-docs/" | ||
destination_repo: "PalisadoesFoundation/talawa" | ||
destination_folder: "docs/docs/auto-docs" | ||
user_email: "${{env.email}}" | ||
user_name: "${{github.actor}}" | ||
commit_message: "Writing talawa-mobile-docs to auto-docs" | ||
|
||
Branch-check: | ||
if: ${{ github.actor != 'dependabot[bot]' && !contains(github.event.pull_request.labels.*.name, 'ignore-sensitive-files-pr') }} | ||
name: "Base branch check" | ||
|