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

Daily reference docs for JS #15749

Merged
merged 74 commits into from
Jul 1, 2021
Merged

Daily reference docs for JS #15749

merged 74 commits into from
Jul 1, 2021

Conversation

danieljurek
Copy link
Member

@danieljurek danieljurek commented Jun 15, 2021

The eng/common changes are tracked in PR Azure/azure-sdk-tools#1725

Adds daily reference docs capabilities

  • Unified pipeline daily builds will automatically update a dev branch with appropriate package metadata and onboarding info
  • Changes how metadata is updated (this also splits into "legacy" and "modern" metadata update methods)
  • Starts DevOps pipelines against a daily branch.

Process in action:

@danieljurek danieljurek added the Central-EngSys This issue is owned by the Engineering System team. label Jun 15, 2021
@danieljurek danieljurek requested review from weshaggard and scbedd June 15, 2021 21:15
@danieljurek danieljurek self-assigned this Jun 15, 2021
@danieljurek danieljurek force-pushed the djurek/daily-ref-docs-2 branch from 52e5243 to c60fe1a Compare June 21, 2021 18:23
}
}

$packageMetadataArray = (Get-CSVMetadata).Where({ $_.Package -eq $packageInfo.Name })
$packageMetadataArray = (Get-CSVMetadata).Where({ $_.Package -eq $packageInfo.Name -and $_.GroupId -eq $packageInfo.Group -and $_.Hide -ne 'true' -and $_.New -eq 'true' })
Copy link
Member

Choose a reason for hiding this comment

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

Not sure if this is going to come into play here yet but if we ever enable strict mode .GroupId will fail because it only exists on some language objects.

-SourceBranch "master"
-DefinitionId 3452
-Base64EncodedAuthToken "$(azuresdk-apidrop-devops-queue-build-pat)"
-BuildParametersJson '{"params":"{ \"target_repo\": { \"url\": \"https://github.com/MicrosoftDocs/azure-docs-sdk-node\", \"branch\": \"$(DailyDocsBranchName)\", \"folder\": \"./\" }, \"source_repos\": [] }"}'
Copy link
Member

Choose a reason for hiding this comment

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

nit: potential future follow-up, it would be get it storing this as yml and using convertToJson worked on it to make this more readable and maintainable.

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.

Just the one last issue related to the link replacement but otherwise I think the rest is good once you have finished your test validation.

ghost pushed a commit to Azure/azure-sdk-tools that referenced this pull request Jun 30, 2021
…ing Hide == true (e.g. in template packages). The only information consumed from CSV metadata at this time is the service name which gets normalized and placed in the package overview metadata.
@check-enforcer
Copy link

check-enforcer bot commented Jul 1, 2021

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).

What if I am onboarding a new service?

Often, new services do not have validation pipelines associated with them, in order to bootstrap pipelines for a new service, you can issue the following command as a pull request comment:
/azp run prepare-pipelines
This will run a pipeline that analyzes the source tree and creates the pipelines necessary to build and validate your pull request. Once the pipeline has been created you can trigger the pipeline using the following comment:
/azp run js - [service] - ci

@danieljurek
Copy link
Member Author

/azp run js - core - ci

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@danieljurek danieljurek merged commit 43ecf92 into main Jul 1, 2021
@danieljurek danieljurek deleted the djurek/daily-ref-docs-2 branch July 1, 2021 18:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Central-EngSys This issue is owned by the Engineering System team.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants