Skip to content

mobile: add CircleCI docs generation CI job#24295

Merged
alyssawilk merged 7 commits intomainfrom
mobile-add-circleci-docs-generation-ci-job
Dec 1, 2022
Merged

mobile: add CircleCI docs generation CI job#24295
alyssawilk merged 7 commits intomainfrom
mobile-add-circleci-docs-generation-ci-job

Conversation

@jpsim
Copy link
Copy Markdown
Contributor

@jpsim jpsim commented Dec 1, 2022

This is the CI job that's responsible for building the public website docs at https://envoymobile.io.

Commit Message: mobile: add CircleCI docs generation CI job
Additional Description: This is the CI job that's responsible for building the public website docs at https://envoymobile.io.
Risk Level: Low
Testing: In Envoy Mobile repo.
Docs Changes: Yes :)
Release Notes: None.
Platform Specific Features: Only relevant to mobile.

Part of #23758

This is the CI job that's responsible for building the public website
docs at https://envoymobile.io.

Signed-off-by: JP Simard <jp@jpsim.com>
@repokitteh-read-only
Copy link
Copy Markdown

As a reminder, PRs marked as draft will not be automatically assigned reviewers,
or be handled by maintainer-oncall triage.

Please mark your PR as ready when you want it to be reviewed!

🐱

Caused by: #24295 was opened by jpsim.

see: more, trace.

@jpsim
Copy link
Copy Markdown
Contributor Author

jpsim commented Dec 1, 2022

@alyssawilk do you think you could set up the CircleCI webhook here, mirroring the one defined in Envoy Mobile? https://github.com/envoyproxy/envoy-mobile/settings/hooks/246245000

@jpsim
Copy link
Copy Markdown
Contributor Author

jpsim commented Dec 1, 2022

Ideally we'll migrate this to GitHub Actions, but I'd like to get it up and running as it's defined in Envoy Mobile first.

@phlax
Copy link
Copy Markdown
Member

phlax commented Dec 1, 2022

Ideally we'll migrate this to GitHub Actions

i was wondering about this - the way we currently publish Envoy docs is with GCS - this is also what lets us use /docs etc on PRs so we can always check outputs etc without having to mentally parse rst

iiuc this set up requires using azp (cc @lizan for confirmation on this) so im wondering whether it makes sense to use that for this job specifically

@alyssawilk
Copy link
Copy Markdown
Contributor

alyssawilk commented Dec 1, 2022

Theoretically I've done the webhook so my high level question is do we want to limit the work to only pull requests containing mobile files or changes to circileci as we did with all the yaml?

@jpsim
Copy link
Copy Markdown
Contributor Author

jpsim commented Dec 1, 2022

Theoretically I've done the webhook

ok I'll push an empty commit to hopefully trigger it.

do we want to limit this to only pushes containing mobile files or changes to circileci as we did with all the yaml?

I'm inclined to build on every change for now, the job is reliable in my experience, and pretty fast, finishing in ~2 minutes: https://app.circleci.com/pipelines/github/envoyproxy/envoy-mobile/12852/workflows/98b67571-3236-4b62-aac7-f20c9696f584/jobs/13177

Signed-off-by: JP Simard <jp@jpsim.com>
@jpsim jpsim force-pushed the mobile-add-circleci-docs-generation-ci-job branch from 56f1de8 to 1a60dd2 Compare December 1, 2022 17:43
@alyssawilk
Copy link
Copy Markdown
Contributor

SG. from the UI I think we need to land this before I can configure it on app.circleci.com so want lmk if you want to merge as is or have me point to your branch first to test

@jpsim
Copy link
Copy Markdown
Contributor Author

jpsim commented Dec 1, 2022

have me point to your branch first to test

If it's possible to point to this branch so we can validate this before we merge, that'd be great.

alyssawilk
alyssawilk previously approved these changes Dec 1, 2022
- run: mobile/docs/build.sh
- add_ssh_keys:
fingerprints:
- "a2:f7:59:f0:01:8b:91:31:ab:0c:3f:9f:25:4c:1e:e5"
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

this is one of the few things that differed per project so not sure if it'll work but I'm fine landing and seeing :-P

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Presumably this means publishing won't work.

jpsim added 2 commits December 1, 2022 12:59
Signed-off-by: JP Simard <jp@jpsim.com>
Signed-off-by: JP Simard <jp@jpsim.com>
@repokitteh-read-only
Copy link
Copy Markdown

CC @envoyproxy/mobile-maintainers: FYI only for changes made to (mobile/).
envoyproxy/mobile-maintainers assignee is @Augustyniak

🐱

Caused by: #24295 was synchronize by jpsim.

see: more, trace.

jpsim added 2 commits December 1, 2022 13:13
Signed-off-by: JP Simard <jp@jpsim.com>
Signed-off-by: JP Simard <jp@jpsim.com>
@jpsim
Copy link
Copy Markdown
Contributor Author

jpsim commented Dec 1, 2022

Docs were successfully pushed in envoy-mobile/envoy-mobile.github.io@9f451fb

Signed-off-by: JP Simard <jp@jpsim.com>
@jpsim jpsim marked this pull request as ready for review December 1, 2022 18:36
@jpsim jpsim requested a review from alyssawilk December 1, 2022 18:36
@alyssawilk alyssawilk merged commit 937818c into main Dec 1, 2022
@jpsim jpsim deleted the mobile-add-circleci-docs-generation-ci-job branch December 1, 2022 18:40
@jpsim jpsim mentioned this pull request Dec 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants