Skip to content

SC-19802 Add CI/CD Monitors, CI/CD Groups and Dynamic URLs docs #676

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

Merged

Conversation

HSSalman
Copy link
Contributor

@HSSalman HSSalman commented May 6, 2025

Docs covering the upcoming Synthetics GitHub CI/CD integration. I was going to include the installation instructions too since I have notes on them, but while writing them out I didn't really like the added complexity. I'll try some ideas tomorrow to see if those can simplify things - it's mainly the GH API that's introducing the complexity, and there may be a way around it through an official Sematext Synthetics CI/CD App.

Meanwhile, @fulyauluturk can you please take a look at the current content to see if anything needs clearing up? I think I covered pretty much everything on the SC side, but I'd appreciate some extra input.

@HSSalman HSSalman requested a review from fulyauluturk May 6, 2025 21:01
@fulyauluturk
Copy link
Contributor

@HSSalman It is a little bit unclear that once you set that <DYNAMIC_URL> how you should set things up for each run to replace the placeholder automatically. For example, how will each run know to replace <DYNAMIC_URL>/health with pr-1227.test.myapp.com/health and how it'll increase the PR number automatically for each run. This should be configured within the GH action script, right? Shouldn't we state that and maybe link it to installation instructions once we have that page.

runs-on: ubuntu-latest
steps:
- name: Get Vercel Deployment URL
id: vercel_deployment_url
Copy link
Member

Choose a reason for hiding this comment

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

@HSSalman if I don't use Vercel, what do I put here? (what a user might be wondering)


- name: Run Sematext Synthetics CI/CD Integration
id: sematext_check
uses: hssalman/[email protected]
Copy link
Member

Choose a reason for hiding this comment

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

@HSSalman is this the actual thing one will have to use or will this become sematext/.... ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It'll be an official sematext repo, yes. This is just a temporary one until we're satisfied with how things work and I left it in so that Fulya can easily try out these install guides.

@HSSalman
Copy link
Contributor Author

These should be the final versions unless there's some feedback that says otherwise.

However, @otisg @fulyauluturk we still need to decide what we'll do with the old pages, since they point to some workflows which can only run one monitor per action, which doesn't seem useful and will only confuse users with multiple variants of what they might think is the same action.

IMO we should delete all the old stuff from the ci-cd folder and just keep these new pages.

@fulyauluturk
Copy link
Contributor

I agree, let me first check these and try to install CI/CD one more time and we'll have a final decision.

@HSSalman HSSalman merged commit 87758a5 into master May 21, 2025
@HSSalman HSSalman deleted the hsa_SC-19802_add_synthetics_github_cicd_integration_docs branch May 21, 2025 13:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants