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

Add basic ga tag w/ settable campaignid #1848

Merged
merged 2 commits into from
Jul 27, 2021

Conversation

scbedd
Copy link
Member

@scbedd scbedd commented Jul 26, 2021

Alrighty, I think this was about the cleanest as I could find to do this.

  1. Add new header template that adds GA tag.
    • This header was generated by docfx template export default -> add my stuff -> copy into partials folder.
  2. Add campaignId argument to GenerateDocFxToCConfig (which is really the function that builds the skeleton of the site)
    • This will optionally inject a specific campaignId if presented

Have run a test using the java folks as a guinea pig. To take advantage of this, merely update the call in Language-Settings.ps1 -> Get-<language>-GithubIODocIndex()

image

@scbedd scbedd requested a review from a team as a code owner July 26, 2021 22:29
@azure-sdk
Copy link
Collaborator

The following pipelines have been queued for testing:
java - template
java - template - tests
js - template
net - template
net - template - tests
python - template
python - template - tests
You can sign off on the approval gate to test the release stage of each pipeline.
See eng/common workflow

@check-enforcer-staging
Copy link

This pull request is protected by Check Enforcer.

What is Check Enforcer?

Check Enforcer helps ensure all pull requests are covered by at least one check-run (typically an Azure Pipeline). When all check-runs associated with this pull request pass then Check Enforcer itself will pass.

Why am I getting this message?

You are getting this message because Check Enforcer did not detect any check-runs being associated with this pull request within five minutes. This may indicate that your pull request is not covered by any pipelines and so Check Enforcer is correctly blocking the pull request being merged.

What should I do now?

If the check-enforcer check-run is not passing and all other check-runs associated with this PR are passing (excluding license-cla) then you could try telling Check Enforcer to evaluate your pull request again. You can do this by adding a comment to this pull request as follows:
/check-enforcer evaluate
Typically evaulation only takes a few seconds. If you know that your pull request is not covered by a pipeline and this is expected you can override Check Enforcer using the following command:
/check-enforcer override
Note that using the override command triggers alerts so that follow-up investigations can occur (PRs still need to be approved as normal).

@scbedd
Copy link
Member Author

scbedd commented Jul 26, 2021

Going to do a couple template releases, then just merge this. It's a fairly transparent update.

Copy link
Member

@weshaggard weshaggard left a comment

Choose a reason for hiding this comment

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

Looks reasonable. Did you plan to also add GA support to the azure-sdk github.io site?

@ghost
Copy link

ghost commented Jul 27, 2021

Hello @azure-sdk!

Because this pull request has the auto-merge label, I will be glad to assist with helping to merge this pull request once all check-in policies pass.

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (@msftbot) and give me an instruction to get started! Learn more here.

@scbedd
Copy link
Member Author

scbedd commented Jul 27, 2021

/check-enforcer override

@scbedd scbedd merged commit 434bb41 into Azure:main Jul 27, 2021
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.

4 participants