diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4d610c9d..b97ad592 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -162,7 +162,6 @@ as `org.virtuslab::besom-core:X.Y.Z` and `org.virtuslab::besom-:A.B.C-c Language host provider is published to Maven as `pulumi-language-scala-vX.Y.Z-OS-ARCH.tar.gz`. - To use development version of the language host provider: ```bash pulumi --logtostderr plugin install language scala $(cat version.txt) --server github://api.github.com/VirtusLab/besom @@ -220,6 +219,7 @@ just cli version update #### Update versions in all other places Manually update versions in all other places, specifically documentation and website, using find&replace. +Remember about `website/docusaurus.config.js:40` Manually update branch names in all places. @@ -260,6 +260,8 @@ just clean-out cli packages maven-all Tip: it's safer to publish the packages on-by-one due to how Maven Central behaves. +In case of any issues, you can try to resolve the issues manually at https://oss.sonatype.org/index.html#stagingRepositories. + #### Finish the release Finish the release on GitHub manually, make sure the changelog is correct and correct git tag was created. diff --git a/website/docs/basics.md b/website/docs/basics.md index 74dc59bf..8614ffc8 100644 --- a/website/docs/basics.md +++ b/website/docs/basics.md @@ -121,13 +121,14 @@ The recommended practice is to **check stack files into source control** as a me Since secret values are encrypted, it is safe to check in these stack settings. ::: -##### Stack information from code - -You can access stack information from your [program](#programs) context using the `urn` method, e.g.: +##### Stack and project information from code +You can access Pulumi stack and project information from your [program](#programs) context using: ```scala -urn.map(_.stack) // the stack name -urn.map(_.project) // the stack name +pulumiProject // the Pulumi project name +pulumiOrganization // the Pulumi organization name +pulumiStack // the Pulumi stack name +urn // the Pulumi stack URN ``` ##### Stack Outputs @@ -140,8 +141,7 @@ To export values from a stack in Besom, use the [`Stack.exports`](exports.md) fu ##### Stack References -[Stack References](https://www.pulumi.com/docs/concepts/stack/#stackreferences) allow you to use outputs from other -[stacks](#stacks) in your [program](#programs). +[Stack References](https://www.pulumi.com/docs/concepts/stack/#stackreferences) allow you to use outputs from other [stacks](#stacks) in your [program](#programs). To reference values from another stack, create an instance of the `StackReference` type using the fully qualified name of the stack as an input, and then read exported stack outputs by their name. @@ -166,8 +166,10 @@ Resources are defined using a [**resource constructor**](constructors.md). Each ```scala val redisNamespace = Namespace(s"redis-cluster-namespace-$name") -redisNamespace.id // the physical name -redisNamespace.urn // the globally unique identifier +redisNamespace.id // the Pulumi ID - a physical name +redisNamespace.urn // the Pulumi URN - a globally unique identifier +redisNamespace.pulumiResourceName // the Pulumi resource name +redisNamespace.typeToken // the Pulumi resource type token redisNamespace.urn.map(_.resourceName) // the logical name redisNamespace.urn.map(_.resourceType) // the resource type ``` diff --git a/website/docs/getting_started.md b/website/docs/getting_started.md index 6f65db63..5b30a178 100644 --- a/website/docs/getting_started.md +++ b/website/docs/getting_started.md @@ -92,11 +92,12 @@ When opened, both [Intellij IDEA](https://www.jetbrains.com/idea/) and [Metals](https://scalameta.org/metals/) should automatically recognize the project and set up the IDE accordingly. -[sbt](https://www.scala-sbt.org/) is also supported out-of-the-box but is not recommended due to -slower iteration speed. Use of sbt support is suggested for situations where managed infrastructure +[sbt](https://www.scala-sbt.org/), [gradle](https://gradle.org/) and [maven](https://maven.apache.org/) are also supported out-of-the-box, +but are **not recommended** due to slower iteration speed. +Use of `sbt`, `gradle` or `mvn` support is suggested for situations where managed infrastructure is being added to an already existing project that uses sbt as the main build tool. -IDE setup for `sbt` works automatically with both Intellij IDEA and Metals. +IDE setup for `sbt`, `gradle` or `mvn` works automatically with both Intellij IDEA and Metals. [Mill](https://mill-build.com/) is not yet supported. diff --git a/website/docs/missing.md b/website/docs/missing.md index 84d99d25..e992a34f 100644 --- a/website/docs/missing.md +++ b/website/docs/missing.md @@ -3,10 +3,10 @@ title: Missing features --- Some Pulumi features are not yet implemented. The most notable ones are: -* [Component-based packages](https://www.pulumi.com/docs/using-pulumi/pulumi-packages/how-to-author/) a.k.a. "remote components" are not yet fully available (targeted for `0.3.0` release). * [Resource aliases](https://www.pulumi.com/docs/concepts/options/aliases/) are not yet available (targeted for `0.3.0` release). * [Automation API](https://www.pulumi.com/docs/guides/automation-api/) is not yet available (targeted for `0.3.0` release). * [Resource transformations](https://www.pulumi.com/docs/concepts/options/transformations/) are not yet available (targeted for `0.3.0` release). +* [State Inputs](https://github.com/VirtusLab/besom/issues/285) are not yet available (todo). * [Dynamic Providers](https://www.pulumi.com/docs/concepts/resources/dynamic-providers/) are not yet available (researching). * [Function serialization](https://www.pulumi.com/docs/concepts/inputs-outputs/function-serialization/) is supported only in Node.js (researching). diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index 0a84eb4d..308ecade 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -37,7 +37,7 @@ const config = { }, customFields: { - besomVersion: '0.1.0' // TODO process.env.BESOM_VERSION + besomVersion: '0.2.0' // TODO process.env.BESOM_VERSION }, presets: [